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": "f0601fea-8e96-436c-b83f-4ab109899342",
"jobs_id": "56b68593-a616-4c86-86f5-a1447bc86919",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d0156440-26f4-491f-b845-02ea5554a663",
"_parent_id": "e48a85b4-84b0-4d9c-8c20-2437016d39f1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "79b83c03-3c2f-4442-a539-58be985145a1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b8a37131-3684-4ecc-8c6b-75be4e192e7d",
"_parent_id": "43013733-d804-49ef-ba88-479c4589e8cf",
"root_parent_id": "4b3e07fe-3d4b-4f4a-947d-d1fe6d3f015a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c8c4808b-964d-4860-a1ea-466df9095b4f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0672f491-513b-4869-8d1a-8113ef062cf2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7cad3d21-57e2-43b0-9bdf-843ad5868085",
"_parent_code": "sample string 6",
"sales_organization_id": "4cf68397-6d86-4a88-8813-a6e388e7e2b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "12bbba5b-5cb3-4576-b19d-d69a5bed716c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9904c4a4-0e6b-4b12-90a9-53831e959900",
"db_currency_id": "010d9c46-c071-459e-98e1-07fd2447c7f5",
"db_language_id": "92fe1f43-e758-416d-ac96-657d523679b8",
"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-10-07T20:39:47.9497601+00:00"
},
"modified_dateutc": "2026-10-07T20:39:47.9497601+00:00"
},
"equipment_model_id": "583bd07a-cdb5-402f-8faf-5b58c8a92ae7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3a28c6b6-b555-4e1b-a569-8228dc126460",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cf55b845-747b-42b8-bb06-26d086901859",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a6014eb0-506b-4194-ba0b-f4a16bd2597a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "19a781b2-83fd-4edb-afb5-9b780c13f7fd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "12bbba5b-5cb3-4576-b19d-d69a5bed716c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9904c4a4-0e6b-4b12-90a9-53831e959900",
"db_currency_id": "010d9c46-c071-459e-98e1-07fd2447c7f5",
"db_language_id": "92fe1f43-e758-416d-ac96-657d523679b8",
"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-10-07T20:39:47.9497601+00:00"
},
"modified_dateutc": "2026-10-07T20:39:47.9497601+00:00"
},
"equipment_family_id": "37d14e56-7c97-47f5-9e2e-ce413ffdc830",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0672f491-513b-4869-8d1a-8113ef062cf2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7cad3d21-57e2-43b0-9bdf-843ad5868085",
"_parent_code": "sample string 6",
"sales_organization_id": "4cf68397-6d86-4a88-8813-a6e388e7e2b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "12bbba5b-5cb3-4576-b19d-d69a5bed716c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9904c4a4-0e6b-4b12-90a9-53831e959900",
"db_currency_id": "010d9c46-c071-459e-98e1-07fd2447c7f5",
"db_language_id": "92fe1f43-e758-416d-ac96-657d523679b8",
"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-10-07T20:39:47.9497601+00:00"
},
"modified_dateutc": "2026-10-07T20:39:47.9497601+00:00"
},
"date_in_production_since": "2026-10-07T20:39:47.9497601+00:00",
"date_out_of_production_since": "2026-10-07T20:39:47.9497601+00:00",
"date_end_support": "2026-10-07T20:39:47.9497601+00:00",
"sales_organization_id": "edbc0a92-b2f4-431b-95b5-a1e2db380134",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "12bbba5b-5cb3-4576-b19d-d69a5bed716c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9904c4a4-0e6b-4b12-90a9-53831e959900",
"db_currency_id": "010d9c46-c071-459e-98e1-07fd2447c7f5",
"db_language_id": "92fe1f43-e758-416d-ac96-657d523679b8",
"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-10-07T20:39:47.9497601+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-10-07T20:39:47.9497601+00:00"
},
"project_status_id": "31376951-6f7e-406e-93f5-509fa23e472f",
"project_status_code": "sample string 10",
"project_status": {
"id": "007aa8d1-4165-467f-a90e-a497f2f2c74b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ad7d6ccc-bc5b-4291-a5ae-443d00ec0c04",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "12bbba5b-5cb3-4576-b19d-d69a5bed716c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9904c4a4-0e6b-4b12-90a9-53831e959900",
"db_currency_id": "010d9c46-c071-459e-98e1-07fd2447c7f5",
"db_language_id": "92fe1f43-e758-416d-ac96-657d523679b8",
"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-10-07T20:39:47.9497601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-07T20:39:47.9497601+00:00"
},
"company_id": "36d8c419-17e4-45e5-859f-875a297c7113",
"company_code": "sample string 12",
"db_address_id": "fdd7376d-925d-4060-9a6a-e51312d087c7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e4b6f945-d4a3-4904-9364-ff6f51cb00b8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3624939e-ab0a-4bf6-80c3-4472f9746127",
"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-10-07T20:39:47.9497601+00:00",
"date_create": "2026-10-07T20:39:47.9497601+00:00",
"date_update": "2026-10-07T20:39:47.9497601+00:00",
"updated_by_user_id": "1ec7f2a3-ace0-4829-806a-e92334537d14",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-07T20:39:47.9497601+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-10-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-07T20:39:47.9497601+00:00",
"date_last_job": "2026-10-07T20:39:47.9497601+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-07T20:39:47.9497601+00:00",
"modified_dateutc": "2026-10-07T20:39:47.9497601+00:00",
"is_mobile_installation": true
},
"job_type_id": "cdaf84b7-0316-425d-bd74-b2c2c7279e9f",
"job_type_code": "sample string 7",
"job_type": {
"id": "4febac02-d2ae-49d7-b911-f1c172f9cfc4",
"name": "sample string 2",
"sales_organization_id": "2aa2fcc2-339f-4857-bf9b-c1cb15ce41f8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-07T20:39:47.9497601+00:00",
"code": "sample string 7"
},
"job_priority_id": "9b56d586-1421-448a-9f90-81ce74698ccb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ed77e963-1eba-4f2a-85bc-d85919e10b13",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "20135afb-76fb-4df5-92af-d264077cd288",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "12bbba5b-5cb3-4576-b19d-d69a5bed716c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9904c4a4-0e6b-4b12-90a9-53831e959900",
"db_currency_id": "010d9c46-c071-459e-98e1-07fd2447c7f5",
"db_language_id": "92fe1f43-e758-416d-ac96-657d523679b8",
"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-10-07T20:39:47.9497601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-07T20:39:47.9497601+00:00"
},
"job_status_id": "c66d821a-326d-475c-a928-bd1f4cf87f27",
"job_status_code": "sample string 11",
"db_address_id": "d43c3d19-7b14-495e-901e-abe9ba9c191c",
"contact_id": "fe8e5391-3f61-454a-b7fe-b8d2f9464206",
"requested_by_company_id": "f47ce76c-56a0-468d-a83e-716949f301cc",
"requested_by_contact_id": "c26bb633-e8f4-4f19-bf8c-069413774bf7",
"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-10-07T20:39:47.9497601+00:00",
"due_date": "2026-10-07T20:39:47.9497601+00:00",
"date_create": "2026-10-07T20:39:47.9497601+00:00",
"date_update": "2026-10-07T20:39:47.9497601+00:00",
"date_closed": "2026-10-07T20:39:47.9497601+00:00",
"suggested_user_id": "81cda45e-1c5f-4e12-998f-0d33c0e1afe8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4e4d9a57-6f63-4c80-a44e-dcbdb66d2055",
"db_language_id": "1bb56fb7-a59c-42bd-bf54-a9568f0255cc",
"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-10-07T20:39:47.9497601+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7e9a98e3-b473-4c4a-8258-7838fdf76ed8",
"sales_organization": {
"id": "12bbba5b-5cb3-4576-b19d-d69a5bed716c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9904c4a4-0e6b-4b12-90a9-53831e959900",
"db_currency_id": "010d9c46-c071-459e-98e1-07fd2447c7f5",
"db_language_id": "92fe1f43-e758-416d-ac96-657d523679b8",
"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-10-07T20:39:47.9497601+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b349d514-3cb8-4be2-9daf-f44867877db8",
"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": "c800ffad-f778-4e0e-b092-b4674e492b88",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-07T20:39:47.967336+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "787bda06-95e2-4e31-9ab6-c88ef6dc3609"
},
"suggested_date_start": "2026-10-07T20:39:47.967336+00:00",
"skill_id": "9ad1e54b-8cef-43a3-a940-b20e275d613b",
"skill_code": "sample string 32",
"skill": {
"id": "c905f66e-60c3-40ca-bf12-f4e5075e4bd4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "33a5caa0-75bd-4035-bf93-07de07b4ad47",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "12bbba5b-5cb3-4576-b19d-d69a5bed716c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9904c4a4-0e6b-4b12-90a9-53831e959900",
"db_currency_id": "010d9c46-c071-459e-98e1-07fd2447c7f5",
"db_language_id": "92fe1f43-e758-416d-ac96-657d523679b8",
"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-10-07T20:39:47.9497601+00:00"
},
"modified_dateutc": "2026-10-07T20:39:47.967336+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e2782824-e847-4a91-a887-1d452c7862e1",
"date_reported_by_company": "2026-10-07T20:39:47.967336+00:00",
"id2": 36,
"company_id": "864f2f19-1a50-4ffa-abec-89dee390f012",
"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": "e9c16b39-983f-4e52-87c5-d3ad2a1e983a",
"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-10-07T20:39:47.967336+00:00"
},
"work_instruction_details_id": "b64bbb8e-3ad7-41a4-98b8-39ac0a9b45c8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7dde60a4-3079-49c7-bc9b-7624481a5570",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b7dc135e-014a-443c-bf43-e9b844044cd3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-07T20:39:47.967336+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": "61e2480a-f5a2-449f-a719-69ef158d5050",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-07T20:39:47.967336+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.