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": "67d5b137-cc93-482e-9386-63f1fe078f4d",
"jobs_id": "6ae8bdad-6b30-477a-9328-fc8608e4b5b6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0f6892e8-edb8-4f53-af66-6570f2404638",
"_parent_id": "183e8402-a881-4d75-aac1-a22d86171b2c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0f6a93b2-eba2-4188-8858-9732c2ea8816",
"project_reference_back_office": "sample string 5",
"project": {
"id": "305873b0-384a-4f21-bb82-ecf8a1a17597",
"_parent_id": "21ba0e22-6a06-4c98-ae4f-b251f3d97bf9",
"root_parent_id": "2a2e938e-8bb5-4c55-b873-ba418adcda3b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "141095db-4e00-4f0e-a2cc-5a20814b4a4a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1549d64a-2239-4a2d-90cb-fb40f3ff9806",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01745736-db4f-4ea6-8030-6cf619744e79",
"_parent_code": "sample string 6",
"sales_organization_id": "0911339c-f34f-4b67-bfb7-d000fff03477",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8effb1f-b2f0-418c-86bb-028f8af23509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd3f067-b02d-4b8e-be62-e1155b08f416",
"db_currency_id": "3152b164-2ab9-4d59-8fec-c65405e86f99",
"db_language_id": "a9117fb7-832e-487b-98d5-fff5fa9cf14f",
"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-11-03T14:48:42.0540516+00:00"
},
"modified_dateutc": "2026-11-03T14:48:42.0540516+00:00"
},
"equipment_model_id": "3a623931-71b1-490e-8cda-0897911c0f5d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "26e77e97-c0eb-454c-8d89-089938287cb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2ac9a0cd-254b-4b50-b005-b2bf4a324a84",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6376e805-c44f-4c89-9840-bf953d4014dd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f60b5ab6-8236-4c3a-bd4f-d0b7a4db60ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8effb1f-b2f0-418c-86bb-028f8af23509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd3f067-b02d-4b8e-be62-e1155b08f416",
"db_currency_id": "3152b164-2ab9-4d59-8fec-c65405e86f99",
"db_language_id": "a9117fb7-832e-487b-98d5-fff5fa9cf14f",
"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-11-03T14:48:42.0540516+00:00"
},
"modified_dateutc": "2026-11-03T14:48:42.0540516+00:00"
},
"equipment_family_id": "1fd6ff84-09d0-48f6-af3c-a2ea7124e098",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1549d64a-2239-4a2d-90cb-fb40f3ff9806",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01745736-db4f-4ea6-8030-6cf619744e79",
"_parent_code": "sample string 6",
"sales_organization_id": "0911339c-f34f-4b67-bfb7-d000fff03477",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8effb1f-b2f0-418c-86bb-028f8af23509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd3f067-b02d-4b8e-be62-e1155b08f416",
"db_currency_id": "3152b164-2ab9-4d59-8fec-c65405e86f99",
"db_language_id": "a9117fb7-832e-487b-98d5-fff5fa9cf14f",
"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-11-03T14:48:42.0540516+00:00"
},
"modified_dateutc": "2026-11-03T14:48:42.0540516+00:00"
},
"date_in_production_since": "2026-11-03T14:48:42.0540516+00:00",
"date_out_of_production_since": "2026-11-03T14:48:42.0540516+00:00",
"date_end_support": "2026-11-03T14:48:42.0540516+00:00",
"sales_organization_id": "a5b36487-1f75-4859-be38-e668ecf557fe",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a8effb1f-b2f0-418c-86bb-028f8af23509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd3f067-b02d-4b8e-be62-e1155b08f416",
"db_currency_id": "3152b164-2ab9-4d59-8fec-c65405e86f99",
"db_language_id": "a9117fb7-832e-487b-98d5-fff5fa9cf14f",
"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-11-03T14:48:42.0540516+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-11-03T14:48:42.0540516+00:00"
},
"project_status_id": "8b0cf833-f678-422c-9f7a-0040a900fa8c",
"project_status_code": "sample string 10",
"project_status": {
"id": "6853619a-7f43-4312-b0ff-1f685e795a39",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4095355a-4f7f-48da-9856-048484c4a203",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8effb1f-b2f0-418c-86bb-028f8af23509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd3f067-b02d-4b8e-be62-e1155b08f416",
"db_currency_id": "3152b164-2ab9-4d59-8fec-c65405e86f99",
"db_language_id": "a9117fb7-832e-487b-98d5-fff5fa9cf14f",
"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-11-03T14:48:42.0540516+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-03T14:48:42.0540516+00:00"
},
"company_id": "ef1973e3-7392-4ce1-927c-046cdce9ee21",
"company_code": "sample string 12",
"db_address_id": "6710dc0c-fe3e-47db-ae6c-2919371d4b43",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fdae8040-3fa5-426d-82d8-15969b3ce33b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "702b060d-aa64-40ce-a66c-a00d844fda1e",
"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-11-03T14:48:42.0540516+00:00",
"date_create": "2026-11-03T14:48:42.0540516+00:00",
"date_update": "2026-11-03T14:48:42.0540516+00:00",
"updated_by_user_id": "007f0464-2752-4dc3-a627-6e3c55b1a994",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-03T14:48:42.0540516+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-11-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-03T14:48:42.0540516+00:00",
"date_last_job": "2026-11-03T14:48:42.0540516+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-03T14:48:42.0540516+00:00",
"modified_dateutc": "2026-11-03T14:48:42.0540516+00:00",
"is_mobile_installation": true
},
"job_type_id": "dceac680-ca48-446b-807c-078c6928be56",
"job_type_code": "sample string 7",
"job_type": {
"id": "bdee6dcd-c4e3-4d50-af85-a398817af7e0",
"name": "sample string 2",
"sales_organization_id": "870a1af7-aec8-4292-b1e5-a8cf41131150",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-03T14:48:42.0540516+00:00",
"code": "sample string 7"
},
"job_priority_id": "7f786f33-0fcd-4871-a232-e7d59cc47f91",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f70e06d6-6292-4b46-97da-13ececcc3abe",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "334bb7c6-1563-4583-86d3-6ad9f7479a56",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8effb1f-b2f0-418c-86bb-028f8af23509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd3f067-b02d-4b8e-be62-e1155b08f416",
"db_currency_id": "3152b164-2ab9-4d59-8fec-c65405e86f99",
"db_language_id": "a9117fb7-832e-487b-98d5-fff5fa9cf14f",
"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-11-03T14:48:42.0540516+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-03T14:48:42.0660321+00:00"
},
"job_status_id": "a0a784d0-4b46-4770-bc0b-25426f363e14",
"job_status_code": "sample string 11",
"db_address_id": "95b417fb-07b5-4756-8b59-95de198fd071",
"contact_id": "67bcfe8b-0547-4fdc-a0d4-73f4d3fe9a5a",
"requested_by_company_id": "e1fd4db6-7bcf-4345-b326-118f6f5e34ea",
"requested_by_contact_id": "a626dcba-b25d-4070-b29d-10f42d108327",
"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-11-03T14:48:42.0660321+00:00",
"due_date": "2026-11-03T14:48:42.0660321+00:00",
"date_create": "2026-11-03T14:48:42.0660321+00:00",
"date_update": "2026-11-03T14:48:42.0660321+00:00",
"date_closed": "2026-11-03T14:48:42.0660321+00:00",
"suggested_user_id": "150fb573-d352-4158-8ce8-728cdf5ceb4b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7a98a361-7718-4cc5-8423-69bd0f17b59b",
"db_language_id": "925aac48-6eb4-48c7-b2df-b457043137e0",
"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-11-03T14:48:42.0660321+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "de6dabb0-56b8-493d-9b17-28ace25400df",
"sales_organization": {
"id": "a8effb1f-b2f0-418c-86bb-028f8af23509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd3f067-b02d-4b8e-be62-e1155b08f416",
"db_currency_id": "3152b164-2ab9-4d59-8fec-c65405e86f99",
"db_language_id": "a9117fb7-832e-487b-98d5-fff5fa9cf14f",
"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-11-03T14:48:42.0540516+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "57ed3502-82e4-43cb-986d-d66709cff6f5",
"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": "7410c391-a1e6-43e6-af2e-216f0607f6d8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-03T14:48:42.0660321+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8312b49b-9402-4629-81b7-2b19710ed5c7"
},
"suggested_date_start": "2026-11-03T14:48:42.0660321+00:00",
"skill_id": "d566e93c-361d-425c-952b-306fe99bdd64",
"skill_code": "sample string 32",
"skill": {
"id": "00543609-028b-480d-9d36-6180c20bb2b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d2596981-4b91-45af-b590-9e719df6584c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8effb1f-b2f0-418c-86bb-028f8af23509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd3f067-b02d-4b8e-be62-e1155b08f416",
"db_currency_id": "3152b164-2ab9-4d59-8fec-c65405e86f99",
"db_language_id": "a9117fb7-832e-487b-98d5-fff5fa9cf14f",
"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-11-03T14:48:42.0540516+00:00"
},
"modified_dateutc": "2026-11-03T14:48:42.0660321+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "78e4fbd3-0049-4a63-abf1-3abf4df6441e",
"date_reported_by_company": "2026-11-03T14:48:42.0660321+00:00",
"id2": 36,
"company_id": "e3d672b3-80e5-4942-a65d-5b5dff82c962",
"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": "f2c2cdd9-206f-48cf-b9ad-c3e192124f61",
"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-11-03T14:48:42.0660321+00:00"
},
"work_instruction_details_id": "dfdf1afd-aa12-4365-8006-49e144862d18",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c749dee3-a6ee-4c3d-a3ac-dc4f842d76d6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2e271e53-a561-4e68-98a8-23df20fccde7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-03T14:48:42.0660321+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": "926d6390-12f4-45d3-8883-a3d4214bf110",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-03T14:48:42.0660321+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.