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": "26f5a9e7-1e95-4c11-979f-6c5547b7fe1a",
"jobs_id": "77fc4b1f-1198-42a6-a29b-acc6b6a6a767",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cc3b34c4-8fcd-46cf-870f-0033a0d07b7b",
"_parent_id": "556b2453-4cd8-481a-8f12-3e1a37a8c8bc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1a7eca4a-4d61-44e5-99ea-a91592ea7fdb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "54592907-7749-41f5-94be-5176a3259130",
"_parent_id": "9fd17929-71ad-46ed-b995-11cf9b581c81",
"root_parent_id": "88057cb6-43c7-41c6-88ac-49b83f604991",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d876d00c-dae1-4019-9446-0786d0d94807",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8d9ca14d-0b54-48ae-aa46-7375e7f42570",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78cb06cc-188c-4b78-ba3c-fb22734b284f",
"_parent_code": "sample string 6",
"sales_organization_id": "a72cd386-cc93-4578-9a92-b2a491cd0f59",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f332dea6-4d54-4663-bc36-c95068bdd4a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3401e1ed-c2e5-4103-9697-3aff45d451be",
"db_currency_id": "e3b8e1f7-aafa-447d-b321-508118a79f21",
"db_language_id": "e490ec5b-8168-4608-9c78-b521e21ae10a",
"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-07-14T11:36:50.1446514+00:00"
},
"modified_dateutc": "2026-07-14T11:36:50.1446514+00:00"
},
"equipment_model_id": "94d2517b-0379-4060-826c-8bcc2c405efb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1d4bdee4-a60e-4403-a533-adcb00233fe9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "21d5e0d1-0c01-4bad-b467-374c38b1355f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3f1060e7-ab2d-499d-adcb-a8c951c285f3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b22eeeab-45dd-4120-b9a7-ea41acbb4439",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f332dea6-4d54-4663-bc36-c95068bdd4a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3401e1ed-c2e5-4103-9697-3aff45d451be",
"db_currency_id": "e3b8e1f7-aafa-447d-b321-508118a79f21",
"db_language_id": "e490ec5b-8168-4608-9c78-b521e21ae10a",
"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-07-14T11:36:50.1446514+00:00"
},
"modified_dateutc": "2026-07-14T11:36:50.1446514+00:00"
},
"equipment_family_id": "dadbdc35-a99b-412c-9977-735f9a05b15e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8d9ca14d-0b54-48ae-aa46-7375e7f42570",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78cb06cc-188c-4b78-ba3c-fb22734b284f",
"_parent_code": "sample string 6",
"sales_organization_id": "a72cd386-cc93-4578-9a92-b2a491cd0f59",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f332dea6-4d54-4663-bc36-c95068bdd4a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3401e1ed-c2e5-4103-9697-3aff45d451be",
"db_currency_id": "e3b8e1f7-aafa-447d-b321-508118a79f21",
"db_language_id": "e490ec5b-8168-4608-9c78-b521e21ae10a",
"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-07-14T11:36:50.1446514+00:00"
},
"modified_dateutc": "2026-07-14T11:36:50.1446514+00:00"
},
"date_in_production_since": "2026-07-14T11:36:50.1446514+00:00",
"date_out_of_production_since": "2026-07-14T11:36:50.1446514+00:00",
"date_end_support": "2026-07-14T11:36:50.1446514+00:00",
"sales_organization_id": "8c1655da-d817-487a-9b76-464aea53bb2e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f332dea6-4d54-4663-bc36-c95068bdd4a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3401e1ed-c2e5-4103-9697-3aff45d451be",
"db_currency_id": "e3b8e1f7-aafa-447d-b321-508118a79f21",
"db_language_id": "e490ec5b-8168-4608-9c78-b521e21ae10a",
"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-07-14T11:36:50.1446514+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-07-14T11:36:50.1446514+00:00"
},
"project_status_id": "1cb4e147-b570-4548-83e4-e045f0f7d0ce",
"project_status_code": "sample string 10",
"project_status": {
"id": "f749d1ad-3301-4513-8785-454641c73b53",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a040aefe-24e6-4fa0-9564-b46050e7c74f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f332dea6-4d54-4663-bc36-c95068bdd4a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3401e1ed-c2e5-4103-9697-3aff45d451be",
"db_currency_id": "e3b8e1f7-aafa-447d-b321-508118a79f21",
"db_language_id": "e490ec5b-8168-4608-9c78-b521e21ae10a",
"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-07-14T11:36:50.1446514+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T11:36:50.1446514+00:00"
},
"company_id": "a39cecba-add9-48ba-b631-6bf0281a558a",
"company_code": "sample string 12",
"db_address_id": "8136901c-0182-4bd1-87fd-ae532620b8bf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "56d470e7-837b-4afb-b2d4-8df9e79dd068",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "58ef7779-9d68-42a2-a1a6-9893ada1f87d",
"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-07-14T11:36:50.1446514+00:00",
"date_create": "2026-07-14T11:36:50.1446514+00:00",
"date_update": "2026-07-14T11:36:50.1446514+00:00",
"updated_by_user_id": "9f604bc0-ae9a-4d7f-9c92-9704b7d2e813",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-14T11:36:50.1446514+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-07-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-14T11:36:50.1446514+00:00",
"date_last_job": "2026-07-14T11:36:50.1446514+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-14T11:36:50.1446514+00:00",
"modified_dateutc": "2026-07-14T11:36:50.1446514+00:00",
"is_mobile_installation": true
},
"job_type_id": "a2cc7ea6-1442-460c-93ad-53f85768e1b1",
"job_type_code": "sample string 7",
"job_type": {
"id": "51737774-eb29-4be5-aa7e-6726bd642c3e",
"name": "sample string 2",
"sales_organization_id": "f834b1d1-61f2-40f6-984a-4a69148f8c33",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-14T11:36:50.1446514+00:00",
"code": "sample string 7"
},
"job_priority_id": "a4d37cf0-cd8f-43b4-868d-e461101fc08d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7e72b985-320b-48d2-8a1b-27fdcd760724",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c6618433-7963-4a44-ba48-9885da5e7815",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f332dea6-4d54-4663-bc36-c95068bdd4a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3401e1ed-c2e5-4103-9697-3aff45d451be",
"db_currency_id": "e3b8e1f7-aafa-447d-b321-508118a79f21",
"db_language_id": "e490ec5b-8168-4608-9c78-b521e21ae10a",
"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-07-14T11:36:50.1446514+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T11:36:50.1446514+00:00"
},
"job_status_id": "5257724c-a2b8-4070-b44e-6f5433ed2606",
"job_status_code": "sample string 11",
"db_address_id": "fc306d79-be76-4c1a-b499-299812349fa3",
"contact_id": "060ca5f6-325a-4723-b035-91d4e79b6cc2",
"requested_by_company_id": "2270b6a5-3c85-40ea-b846-7fa4518458b0",
"requested_by_contact_id": "786f5db4-3d8c-48ad-b56e-78872cee511b",
"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-07-14T11:36:50.1446514+00:00",
"due_date": "2026-07-14T11:36:50.1446514+00:00",
"date_create": "2026-07-14T11:36:50.1446514+00:00",
"date_update": "2026-07-14T11:36:50.1446514+00:00",
"date_closed": "2026-07-14T11:36:50.1446514+00:00",
"suggested_user_id": "d62b5c18-e95e-4e47-ab3b-58f6d4c49092",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9e37d8de-a649-4b6c-b2e3-4a1e961879dc",
"db_language_id": "eecfc124-e2fd-495c-b9be-3646c3c32bd5",
"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-07-14T11:36:50.1446514+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f3bc7312-8e2d-4ef6-a0d8-fed39ed3f1f7",
"sales_organization": {
"id": "f332dea6-4d54-4663-bc36-c95068bdd4a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3401e1ed-c2e5-4103-9697-3aff45d451be",
"db_currency_id": "e3b8e1f7-aafa-447d-b321-508118a79f21",
"db_language_id": "e490ec5b-8168-4608-9c78-b521e21ae10a",
"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-07-14T11:36:50.1446514+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2abfe881-c8ab-4f83-b992-886e192bc669",
"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": "4821dfc2-e627-4b0b-9d91-569e9779dd42",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-14T11:36:50.1602812+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "02ec48f1-4c6a-4837-b704-ae9bffa7ffad"
},
"suggested_date_start": "2026-07-14T11:36:50.1602812+00:00",
"skill_id": "a800ef14-1876-4623-8938-8e5d3133758c",
"skill_code": "sample string 32",
"skill": {
"id": "581bd8f3-e32a-4958-9f0e-c89c60c39628",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dde88dfa-f335-4b99-929f-4a81f868acaf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f332dea6-4d54-4663-bc36-c95068bdd4a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3401e1ed-c2e5-4103-9697-3aff45d451be",
"db_currency_id": "e3b8e1f7-aafa-447d-b321-508118a79f21",
"db_language_id": "e490ec5b-8168-4608-9c78-b521e21ae10a",
"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-07-14T11:36:50.1446514+00:00"
},
"modified_dateutc": "2026-07-14T11:36:50.1602812+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b965d4f4-f8af-46f8-a9f4-cd6553e5eac1",
"date_reported_by_company": "2026-07-14T11:36:50.1602812+00:00",
"id2": 36,
"company_id": "8f0d9d53-0d3c-4463-abca-9bc5a37dcfd0",
"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": "f9ba4f3d-1345-49b1-b3af-e59c98e79012",
"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-07-14T11:36:50.1602812+00:00"
},
"work_instruction_details_id": "d6f64d72-bca3-4c67-89f5-efb977107183",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ec4861df-6754-47e9-855e-e78a4bcaeeb9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4fb6af8b-079d-4372-967d-d588b2ae4394",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-14T11:36:50.1602812+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": "601478af-81e6-4cdc-b052-b5da8ab939d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-14T11:36:50.1602812+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.