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": "117402d7-8b46-40f9-a16e-15c904878ac9",
"jobs_id": "8fe71db6-c973-489e-8543-42e42dcb27e7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "49788c13-5d99-4462-b18f-691ef7714fb1",
"_parent_id": "e619120b-fa0b-4790-b9e5-2908c9897d1c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ce4d6d3b-8593-44b5-9f43-dd88b39d97e1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dc315f33-8ee3-45fe-803a-b9bcf6356bae",
"_parent_id": "d285a88d-b967-4068-bb7d-e9807c4deee3",
"root_parent_id": "606311f7-9706-4206-82a3-dbc85f80ad87",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "52fa899c-5b16-4732-bc65-58768f80cad9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "69b1b481-1b4e-465b-91c5-fc4821974d42",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9efb86ac-6023-4290-a12a-dffef8cb8b5d",
"_parent_code": "sample string 6",
"sales_organization_id": "399a1146-ffd2-49de-8f02-618ffda8acad",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8eb95501-bf78-4a2a-a7fa-e80f7bc5129e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b194462-0fe8-472a-a5a5-392c87d8934b",
"db_currency_id": "e1914a85-3426-4c7c-af57-35eb91900418",
"db_language_id": "810c94f3-a0b0-4a94-9b49-66e044516731",
"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": "2025-12-14T13:59:28.9861242+00:00"
},
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00"
},
"equipment_model_id": "55756718-eea2-4f41-b812-1c338ef383ea",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0164fddc-dd1d-4852-af8a-2cdd36b5f4d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5f7c6581-a77d-47d0-be88-8e173cade004",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2a08bdcb-07e0-4826-a58f-886b9bf40e44",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "56ae4d6c-83ef-47f6-9c92-cc9e9dec8186",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8eb95501-bf78-4a2a-a7fa-e80f7bc5129e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b194462-0fe8-472a-a5a5-392c87d8934b",
"db_currency_id": "e1914a85-3426-4c7c-af57-35eb91900418",
"db_language_id": "810c94f3-a0b0-4a94-9b49-66e044516731",
"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": "2025-12-14T13:59:28.9861242+00:00"
},
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00"
},
"equipment_family_id": "2d8137b8-d0c1-4ab4-bb2f-df8b0f9357c9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "69b1b481-1b4e-465b-91c5-fc4821974d42",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9efb86ac-6023-4290-a12a-dffef8cb8b5d",
"_parent_code": "sample string 6",
"sales_organization_id": "399a1146-ffd2-49de-8f02-618ffda8acad",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8eb95501-bf78-4a2a-a7fa-e80f7bc5129e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b194462-0fe8-472a-a5a5-392c87d8934b",
"db_currency_id": "e1914a85-3426-4c7c-af57-35eb91900418",
"db_language_id": "810c94f3-a0b0-4a94-9b49-66e044516731",
"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": "2025-12-14T13:59:28.9861242+00:00"
},
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00"
},
"date_in_production_since": "2025-12-14T13:59:28.9861242+00:00",
"date_out_of_production_since": "2025-12-14T13:59:28.9861242+00:00",
"date_end_support": "2025-12-14T13:59:28.9861242+00:00",
"sales_organization_id": "bd3f8b54-bc56-4acc-ac31-7cebb620e2ce",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8eb95501-bf78-4a2a-a7fa-e80f7bc5129e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b194462-0fe8-472a-a5a5-392c87d8934b",
"db_currency_id": "e1914a85-3426-4c7c-af57-35eb91900418",
"db_language_id": "810c94f3-a0b0-4a94-9b49-66e044516731",
"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": "2025-12-14T13:59:28.9861242+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": "2025-12-14T13:59:28.9861242+00:00"
},
"project_status_id": "2ddb8e01-3104-43e8-8141-56e0b234b522",
"project_status_code": "sample string 10",
"project_status": {
"id": "c04b383d-ce85-4f72-affc-ba3d19c1c25b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "da95ecfe-24ef-451e-a98b-13ac7446540a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8eb95501-bf78-4a2a-a7fa-e80f7bc5129e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b194462-0fe8-472a-a5a5-392c87d8934b",
"db_currency_id": "e1914a85-3426-4c7c-af57-35eb91900418",
"db_language_id": "810c94f3-a0b0-4a94-9b49-66e044516731",
"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": "2025-12-14T13:59:28.9861242+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00"
},
"company_id": "4bd9096a-2a55-47a1-8372-1ebbe9779e30",
"company_code": "sample string 12",
"db_address_id": "8c07adbf-5507-4909-8f1d-fcce817b1ce5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2fd0f15b-55b1-4fdc-981f-3da208308af0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9c48d4e3-7b54-45db-b118-84e9676b9c54",
"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": "2025-12-14T13:59:28.9861242+00:00",
"date_create": "2025-12-14T13:59:28.9861242+00:00",
"date_update": "2025-12-14T13:59:28.9861242+00:00",
"updated_by_user_id": "16421e22-da46-493a-8263-570f690b3b50",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-14T13:59:28.9861242+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": "2025-12-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-14T13:59:28.9861242+00:00",
"date_last_job": "2025-12-14T13:59:28.9861242+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-14T13:59:28.9861242+00:00",
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00",
"is_mobile_installation": true
},
"job_type_id": "3611a7b9-2719-49e4-8f26-eeaf362164aa",
"job_type_code": "sample string 7",
"job_type": {
"id": "5d3fd74b-5d26-4a06-8e4b-55468e421f2c",
"name": "sample string 2",
"sales_organization_id": "9051a930-02ca-4976-af09-e30c92a000ec",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00",
"code": "sample string 7"
},
"job_priority_id": "1ca8e71e-18c0-4fb4-b911-edc9b7bada7f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "65a73b86-b9f9-4594-bab4-a1193a63cd6b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "43bb4052-67d7-487a-8f36-e73d11b93d4e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8eb95501-bf78-4a2a-a7fa-e80f7bc5129e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b194462-0fe8-472a-a5a5-392c87d8934b",
"db_currency_id": "e1914a85-3426-4c7c-af57-35eb91900418",
"db_language_id": "810c94f3-a0b0-4a94-9b49-66e044516731",
"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": "2025-12-14T13:59:28.9861242+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00"
},
"job_status_id": "df25dd86-832b-48d5-bbd2-cc25eec9e0f5",
"job_status_code": "sample string 11",
"db_address_id": "f95e717a-5a74-4e24-a497-095709ca1499",
"contact_id": "813278a5-142a-4133-846e-1f9c5582cbc1",
"requested_by_company_id": "20ec0310-534c-4080-be15-5d4a243e7385",
"requested_by_contact_id": "7878978c-703e-4234-8f33-4a85b706595b",
"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": "2025-12-14T13:59:28.9861242+00:00",
"due_date": "2025-12-14T13:59:28.9861242+00:00",
"date_create": "2025-12-14T13:59:28.9861242+00:00",
"date_update": "2025-12-14T13:59:28.9861242+00:00",
"date_closed": "2025-12-14T13:59:28.9861242+00:00",
"suggested_user_id": "da25af9d-5f03-4110-9d80-2b2a17ddc4c5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4e0954e0-9210-4d1a-9fb8-39e3f1a10bc0",
"db_language_id": "d7ed3862-dab6-48f2-ac96-7c50ae8d3861",
"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": "2025-12-14T13:59:28.9861242+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ed7f546f-a668-43b3-b267-b59f879ab31d",
"sales_organization": {
"id": "8eb95501-bf78-4a2a-a7fa-e80f7bc5129e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b194462-0fe8-472a-a5a5-392c87d8934b",
"db_currency_id": "e1914a85-3426-4c7c-af57-35eb91900418",
"db_language_id": "810c94f3-a0b0-4a94-9b49-66e044516731",
"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": "2025-12-14T13:59:28.9861242+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "00cd4d61-5bc3-49dd-8857-4f14d50dd440",
"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": "9809e4e3-c56a-4f3b-bdfb-333d150e52e0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8aff932a-d8a9-4969-bcb4-ee9a2c481f95"
},
"suggested_date_start": "2025-12-14T13:59:28.9861242+00:00",
"skill_id": "5aa3f834-1b1d-47d7-a03a-64d25cc109e5",
"skill_code": "sample string 32",
"skill": {
"id": "f31337f7-4b77-413a-b151-929fa70c7333",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3e189186-8aa7-449e-ae39-0ad7aa8020da",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8eb95501-bf78-4a2a-a7fa-e80f7bc5129e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b194462-0fe8-472a-a5a5-392c87d8934b",
"db_currency_id": "e1914a85-3426-4c7c-af57-35eb91900418",
"db_language_id": "810c94f3-a0b0-4a94-9b49-66e044516731",
"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": "2025-12-14T13:59:28.9861242+00:00"
},
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ca2a8042-d774-4680-b1e5-42cd4d5d4499",
"date_reported_by_company": "2025-12-14T13:59:28.9861242+00:00",
"id2": 36,
"company_id": "b8391440-13bf-4783-81f1-9fe14d71cb15",
"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": "745a415c-4c26-4366-9abc-3045b2fd2208",
"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": "2025-12-14T13:59:28.9861242+00:00"
},
"work_instruction_details_id": "1551be5d-f0b3-4500-b59b-05797b6fad4a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5d265eb0-4d97-4aa3-94eb-bcb7e6eeaf7a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b4d2b54e-b06e-43ef-827b-b3132c35dcef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-14T13:59:28.9861242+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": "62dfdb59-9212-4a17-9fbc-7989d46b17c7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-14T13:59:28.9861242+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.