Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "4ce11b10-a264-4bdd-a97b-0c7ec3bd555a",
"jobs_id": "f5931ad5-ad31-4bd3-905e-1ace900a97ea",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6d78c401-50ee-4430-a395-231d8ff4d218",
"_parent_id": "45152ca1-506f-48e2-a1d5-e783006afba2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b6542115-d0f8-4da3-b176-15c1b43797d8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4974759e-c4d8-48fe-b839-1509bef4a488",
"_parent_id": "7208539f-5d28-4e93-a777-c57e4ccd7984",
"root_parent_id": "c62e4b1d-9ba2-4625-9924-2bfc62f36375",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b7c5169c-86cd-47bb-ae43-a5e7dd3f850c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "83e89c28-28d7-4bec-8af3-6fd688e310aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bf0b421d-4370-49b9-839a-242463bcd512",
"_parent_code": "sample string 6",
"sales_organization_id": "bf550b3c-d0c0-4ed6-921c-a18561234a51",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ea7aa81d-df84-4239-9fc8-407216756684",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81937109-2c8f-49e9-96c1-f1aeabf92f77",
"db_currency_id": "c2f86118-43c8-486d-b3bc-e9766530c142",
"db_language_id": "920e1fc0-d008-472e-8b1d-22529a1cea72",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"equipment_model_id": "c06a14ef-c2bf-4b6e-9621-f8e79a8d1da0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "367bdab1-e0ef-4e13-8299-c1dd8cae23e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "49aaef46-f333-4d78-87aa-fb3bba062d42",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "01c068ac-314e-4116-88d7-65d699e724db",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "447e7550-ac3a-4c2f-8e55-3a0942d2a0b9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ea7aa81d-df84-4239-9fc8-407216756684",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81937109-2c8f-49e9-96c1-f1aeabf92f77",
"db_currency_id": "c2f86118-43c8-486d-b3bc-e9766530c142",
"db_language_id": "920e1fc0-d008-472e-8b1d-22529a1cea72",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"equipment_family_id": "808992d8-a49c-49c6-b791-54ade83e91a7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "83e89c28-28d7-4bec-8af3-6fd688e310aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bf0b421d-4370-49b9-839a-242463bcd512",
"_parent_code": "sample string 6",
"sales_organization_id": "bf550b3c-d0c0-4ed6-921c-a18561234a51",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ea7aa81d-df84-4239-9fc8-407216756684",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81937109-2c8f-49e9-96c1-f1aeabf92f77",
"db_currency_id": "c2f86118-43c8-486d-b3bc-e9766530c142",
"db_language_id": "920e1fc0-d008-472e-8b1d-22529a1cea72",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"date_in_production_since": "2026-08-07T15:00:29.2029298+00:00",
"date_out_of_production_since": "2026-08-07T15:00:29.2029298+00:00",
"date_end_support": "2026-08-07T15:00:29.2029298+00:00",
"sales_organization_id": "698fa580-5469-4a00-999e-afd5ccba0b93",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ea7aa81d-df84-4239-9fc8-407216756684",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81937109-2c8f-49e9-96c1-f1aeabf92f77",
"db_currency_id": "c2f86118-43c8-486d-b3bc-e9766530c142",
"db_language_id": "920e1fc0-d008-472e-8b1d-22529a1cea72",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"project_status_id": "bdb666a0-b269-481c-b017-9fb0d3732ad7",
"project_status_code": "sample string 10",
"project_status": {
"id": "5ea088c0-b154-4909-b375-e685bb7001e8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "15d2cc83-7997-4d75-911b-8415d7bcc037",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ea7aa81d-df84-4239-9fc8-407216756684",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81937109-2c8f-49e9-96c1-f1aeabf92f77",
"db_currency_id": "c2f86118-43c8-486d-b3bc-e9766530c142",
"db_language_id": "920e1fc0-d008-472e-8b1d-22529a1cea72",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"company_id": "7c0868b1-2e57-4679-88b9-c59db190e2c1",
"company_code": "sample string 12",
"db_address_id": "f57112e6-3ae6-4288-bd87-c4c2216d5b15",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a576be0c-850b-48e4-801b-8c6e8ff7516d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cdf502da-2c36-4cc6-be0a-7deb504a81c3",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-08-07T15:00:29.2029298+00:00",
"date_create": "2026-08-07T15:00:29.2029298+00:00",
"date_update": "2026-08-07T15:00:29.2029298+00:00",
"updated_by_user_id": "f46edb23-6606-422c-abe0-bc205e4a802d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-07T15:00:29.2029298+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-08-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-07T15:00:29.2029298+00:00",
"date_last_job": "2026-08-07T15:00:29.2029298+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-07T15:00:29.2029298+00:00",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00",
"is_mobile_installation": true
},
"job_type_id": "b085aaef-41f3-4176-9c46-b4b7dabc4c94",
"job_type_code": "sample string 7",
"job_type": {
"id": "e780bfdb-d2cb-46e2-bd00-c3494d8a8742",
"name": "sample string 2",
"sales_organization_id": "2322c62d-1bb1-4acd-a529-3c48543333df",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00",
"code": "sample string 7"
},
"job_priority_id": "a1eca997-e948-4fc1-a942-b03d7c4d2df1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a68bef8d-591c-4225-b9a8-bd91868bd2c8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "188764f6-4bf6-4e67-9750-cf94250dc865",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ea7aa81d-df84-4239-9fc8-407216756684",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81937109-2c8f-49e9-96c1-f1aeabf92f77",
"db_currency_id": "c2f86118-43c8-486d-b3bc-e9766530c142",
"db_language_id": "920e1fc0-d008-472e-8b1d-22529a1cea72",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"job_status_id": "561b328a-65f3-4f71-8baf-84a653b62d76",
"job_status_code": "sample string 11",
"db_address_id": "dcb88462-fc3b-4e9a-a8e1-e3ad1871cabf",
"contact_id": "38fa7b63-4868-40ff-bcd2-dfe92887978a",
"requested_by_company_id": "165a9cf4-db50-4852-84b9-6ef9e0663c5e",
"requested_by_contact_id": "128af250-aacf-4f15-aa3a-33011e4d09eb",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-08-07T15:00:29.2029298+00:00",
"due_date": "2026-08-07T15:00:29.2029298+00:00",
"date_create": "2026-08-07T15:00:29.2029298+00:00",
"date_update": "2026-08-07T15:00:29.2029298+00:00",
"date_closed": "2026-08-07T15:00:29.2029298+00:00",
"suggested_user_id": "9b0e6b2f-c9ec-4cb6-a9fb-0e3da5c1a6a5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "47427e9b-63f5-42ae-8654-0dfc15bd263b",
"db_language_id": "49f9c993-045b-45e3-803c-e50c59fe348d",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-08-07T15:00:29.2029298+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cc3e325a-c987-4e4d-a752-417f1cd864a4",
"sales_organization": {
"id": "ea7aa81d-df84-4239-9fc8-407216756684",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81937109-2c8f-49e9-96c1-f1aeabf92f77",
"db_currency_id": "c2f86118-43c8-486d-b3bc-e9766530c142",
"db_language_id": "920e1fc0-d008-472e-8b1d-22529a1cea72",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "51c5d749-728b-4e0d-be12-91e6452a3925",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "b88647c5-533e-495b-8be6-9cdc9da983b0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "89601cf3-0970-4b80-b190-7660d8bdc7e0"
},
"suggested_date_start": "2026-08-07T15:00:29.2029298+00:00",
"skill_id": "91840629-31dc-40bf-b03e-3fc78cb16bb5",
"skill_code": "sample string 32",
"skill": {
"id": "bfe2e25e-99d5-40f6-a9ab-0d37619e0c25",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "33aee4df-fcb7-4ca9-bf3d-87fa351a683c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ea7aa81d-df84-4239-9fc8-407216756684",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81937109-2c8f-49e9-96c1-f1aeabf92f77",
"db_currency_id": "c2f86118-43c8-486d-b3bc-e9766530c142",
"db_language_id": "920e1fc0-d008-472e-8b1d-22529a1cea72",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "73ac5897-b920-4608-ab0c-bcefd684532f",
"date_reported_by_company": "2026-08-07T15:00:29.2029298+00:00",
"id2": 36,
"company_id": "5d5ac7fc-75a2-4385-9d7b-0da01ce7fc48",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "0f0ac124-b823-422a-8093-c68fe22d8345",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
},
"work_instruction_details_id": "825c8cfa-1bd9-4dda-b86f-a33a70a5afbe",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0dfcf9d6-6a1c-4feb-adc6-1cc3bc896422",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "23acb40b-07b9-474c-ba13-e483690ea6e7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-07T15:00:29.2029298+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "2c163541-a74f-4336-871d-741859d975aa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-07T15:00:29.2029298+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.