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": "cbbd5bdc-26e6-4ace-a7ae-2451c50d49c8",
"jobs_id": "9bd89a0f-a17e-4fc7-a6db-098f16e7a560",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2d728b85-26b7-4524-b902-65a0f9fa2975",
"_parent_id": "0fe5c93b-4aa9-4c94-8639-c5a758735315",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f066c2a2-8ccd-4b6b-b0ae-274e7ab70112",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f3cb8a30-b1b7-4998-abf9-bd15daba2368",
"_parent_id": "ebc0d06d-9b7d-40f5-9b97-02ea8ec4c384",
"root_parent_id": "358db5cc-4aae-4018-91be-db1943d79903",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "807129a5-b4cc-4c80-97fa-d0262137a521",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "932f525c-615b-4a19-9a43-5bc116a1f79d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d7903d19-a83d-4939-a11f-796af1b447f9",
"_parent_code": "sample string 6",
"sales_organization_id": "d3818a6f-d723-4bc1-90f1-8ae5634189df",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5ff36543-8f30-4b91-8064-dc87f6dddc80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10d74a1a-8fcc-4bad-b702-aff730fd597e",
"db_currency_id": "4175e2fc-1ae4-415e-aae4-8743c1357ff8",
"db_language_id": "fd3afeae-d1f1-414a-b65e-07090911ed24",
"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-08T03:04:24.7031705+00:00"
},
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00"
},
"equipment_model_id": "34a8f299-73b8-40c0-984b-08665e4b5e59",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "93727054-3292-4ba3-9839-a4babfa4698c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "81f25c34-46c5-4b11-b7c7-12a14df91b37",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a1fb88be-da43-4e3d-97db-511707ec10d1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "03cbc9c3-2f8c-49bc-abaa-264a865ea61f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ff36543-8f30-4b91-8064-dc87f6dddc80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10d74a1a-8fcc-4bad-b702-aff730fd597e",
"db_currency_id": "4175e2fc-1ae4-415e-aae4-8743c1357ff8",
"db_language_id": "fd3afeae-d1f1-414a-b65e-07090911ed24",
"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-08T03:04:24.7031705+00:00"
},
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00"
},
"equipment_family_id": "67ceb07d-5fb9-463e-8bb6-d90b5a376066",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "932f525c-615b-4a19-9a43-5bc116a1f79d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d7903d19-a83d-4939-a11f-796af1b447f9",
"_parent_code": "sample string 6",
"sales_organization_id": "d3818a6f-d723-4bc1-90f1-8ae5634189df",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5ff36543-8f30-4b91-8064-dc87f6dddc80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10d74a1a-8fcc-4bad-b702-aff730fd597e",
"db_currency_id": "4175e2fc-1ae4-415e-aae4-8743c1357ff8",
"db_language_id": "fd3afeae-d1f1-414a-b65e-07090911ed24",
"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-08T03:04:24.7031705+00:00"
},
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00"
},
"date_in_production_since": "2026-07-08T03:04:24.7031705+00:00",
"date_out_of_production_since": "2026-07-08T03:04:24.7031705+00:00",
"date_end_support": "2026-07-08T03:04:24.7031705+00:00",
"sales_organization_id": "6b21488e-f087-4a8e-b1cf-46049e5dfde2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5ff36543-8f30-4b91-8064-dc87f6dddc80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10d74a1a-8fcc-4bad-b702-aff730fd597e",
"db_currency_id": "4175e2fc-1ae4-415e-aae4-8743c1357ff8",
"db_language_id": "fd3afeae-d1f1-414a-b65e-07090911ed24",
"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-08T03:04:24.7031705+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-08T03:04:24.7031705+00:00"
},
"project_status_id": "e18b2c59-7e35-473b-8109-09b2d5ac4359",
"project_status_code": "sample string 10",
"project_status": {
"id": "95ebff3b-f906-4bb1-8404-fb9af2505fde",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "eb6f95f6-66a0-4a6f-b267-63211a1a6903",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5ff36543-8f30-4b91-8064-dc87f6dddc80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10d74a1a-8fcc-4bad-b702-aff730fd597e",
"db_currency_id": "4175e2fc-1ae4-415e-aae4-8743c1357ff8",
"db_language_id": "fd3afeae-d1f1-414a-b65e-07090911ed24",
"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-08T03:04:24.7031705+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00"
},
"company_id": "14905b82-dbb1-442a-a1b6-09c3a8067b19",
"company_code": "sample string 12",
"db_address_id": "a3f23cd7-65d8-4144-b3dc-a9a08aebf36a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2bf9cd89-9686-45d7-99b3-a3ed9f3a65ac",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "74bb0a7b-fcf3-4226-b880-414cc95a027a",
"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-08T03:04:24.7031705+00:00",
"date_create": "2026-07-08T03:04:24.7031705+00:00",
"date_update": "2026-07-08T03:04:24.7031705+00:00",
"updated_by_user_id": "2fe16798-24a2-441e-ab46-2ff13526f603",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-08T03:04:24.7031705+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-08T03:04:24.7031705+00:00",
"date_last_job": "2026-07-08T03:04:24.7031705+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-08T03:04:24.7031705+00:00",
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00",
"is_mobile_installation": true
},
"job_type_id": "e8c9b7d8-54a4-4d4d-b697-4b6cc3a95541",
"job_type_code": "sample string 7",
"job_type": {
"id": "cd7b3915-d3fb-4838-8f79-596ffa8093fd",
"name": "sample string 2",
"sales_organization_id": "21b157db-8fea-4a39-8dbf-06f5274e0090",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00",
"code": "sample string 7"
},
"job_priority_id": "60a48ca0-541e-4d7b-9833-e530ccbe0a33",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b167321d-9e1d-433e-b269-a121259465f5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "442b534a-a32a-4adc-973b-fe764629c988",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5ff36543-8f30-4b91-8064-dc87f6dddc80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10d74a1a-8fcc-4bad-b702-aff730fd597e",
"db_currency_id": "4175e2fc-1ae4-415e-aae4-8743c1357ff8",
"db_language_id": "fd3afeae-d1f1-414a-b65e-07090911ed24",
"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-08T03:04:24.7031705+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00"
},
"job_status_id": "844b38da-237e-41be-a082-179ef99de8f5",
"job_status_code": "sample string 11",
"db_address_id": "0d47f8e5-454b-49c6-981a-a8062ff57453",
"contact_id": "0849afc9-3ec6-42e1-b4c1-28561e70cc56",
"requested_by_company_id": "0f9e79b3-f14d-412b-bda3-0509f25d527d",
"requested_by_contact_id": "288541ce-3809-4377-93a6-04bc2b444b41",
"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-08T03:04:24.7031705+00:00",
"due_date": "2026-07-08T03:04:24.7031705+00:00",
"date_create": "2026-07-08T03:04:24.7031705+00:00",
"date_update": "2026-07-08T03:04:24.7031705+00:00",
"date_closed": "2026-07-08T03:04:24.7031705+00:00",
"suggested_user_id": "526a8f5c-cb0e-443a-907f-298ed1001dac",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ae9e74e0-4bc7-40fd-b245-df3786a50644",
"db_language_id": "9d9fee57-91b1-4b0e-9d1d-b9cfcfae9090",
"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-08T03:04:24.7031705+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d9e627a7-d554-4f53-a5a8-10d20b97256f",
"sales_organization": {
"id": "5ff36543-8f30-4b91-8064-dc87f6dddc80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10d74a1a-8fcc-4bad-b702-aff730fd597e",
"db_currency_id": "4175e2fc-1ae4-415e-aae4-8743c1357ff8",
"db_language_id": "fd3afeae-d1f1-414a-b65e-07090911ed24",
"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-08T03:04:24.7031705+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e3d2f07f-033f-4a38-8827-8c5249bd1093",
"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": "fc2d30f0-0461-4ace-a223-ef819b8bfabf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aeec989e-ba03-41e7-bc70-7c6f61d2aad5"
},
"suggested_date_start": "2026-07-08T03:04:24.7031705+00:00",
"skill_id": "f2158235-c9a6-46f8-99b9-37e9bf1c60f6",
"skill_code": "sample string 32",
"skill": {
"id": "a37bd3ea-b8fa-4115-b1f3-c34cf336e062",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "aa61245d-1c62-46de-b71c-215c2910caa1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5ff36543-8f30-4b91-8064-dc87f6dddc80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10d74a1a-8fcc-4bad-b702-aff730fd597e",
"db_currency_id": "4175e2fc-1ae4-415e-aae4-8743c1357ff8",
"db_language_id": "fd3afeae-d1f1-414a-b65e-07090911ed24",
"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-08T03:04:24.7031705+00:00"
},
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2c41b482-a003-4803-a8a1-3e832a6f18d5",
"date_reported_by_company": "2026-07-08T03:04:24.7031705+00:00",
"id2": 36,
"company_id": "82dac2bb-9d5b-485c-95b6-b34f9aeb0f60",
"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": "57940942-7e6e-468f-9d65-22ca111446e2",
"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-08T03:04:24.7031705+00:00"
},
"work_instruction_details_id": "fec4c88c-9cfb-48f9-b0f6-39146bfae07a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "04f31f24-26c5-493c-b569-90e4a169181b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "83237fad-53bb-4f62-a20c-5992b431b46c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-08T03:04:24.7031705+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": "345a406a-f0a0-4f86-ba0c-8a30d301d6c9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-08T03:04:24.7031705+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.