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": "386397e6-48fc-4121-b3ca-c9dbfe659908",
"jobs_id": "4a7a0fc6-889e-4d01-8159-72cee67e3e84",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0e0130e0-87fd-4dd3-b974-26c9bb57380b",
"_parent_id": "b58dbf6c-467f-448f-9cbb-0c7f7a215198",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d2665ec6-80a1-453c-923a-7900b02fbf26",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e3d2340a-f35a-4942-808d-2b9ce6c0cce9",
"_parent_id": "65455dbf-6b33-4244-8a4e-ee7c862ffaec",
"root_parent_id": "20d09e59-f3ff-4fb3-954c-e1515d58f8d9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "783db166-e28b-4253-bee6-476a3a7b96c6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d0b507a6-605d-4f2c-8068-8f2f2ec863fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1bdca7fb-2ef4-46a1-bce3-3e9c1dcd33c2",
"_parent_code": "sample string 6",
"sales_organization_id": "3e84a80c-48de-4b30-a60b-f2aa23ee4dac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5337bd78-c937-428b-9c03-15d34b9ca2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b82485fd-249f-4a8f-9ebe-d15ee29f1c10",
"db_currency_id": "ec5efd6b-c9da-4f6f-a7e3-f8ad0486c44b",
"db_language_id": "35866b2b-2e81-44a7-a7f3-cdb05927fa91",
"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-05-21T19:21:41.4495247+00:00"
},
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00"
},
"equipment_model_id": "7e6ddd77-74fb-47b0-8c23-6231fba85dde",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c036cd03-24ed-4e48-adaa-bf3a76816a8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "13d7925e-3383-496c-a634-4d5a6ef2ad2d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c4a09bc6-b1f8-4d1b-9a2b-d71b59d38040",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "468ea4e4-34f7-4e84-b39c-23850078799b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5337bd78-c937-428b-9c03-15d34b9ca2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b82485fd-249f-4a8f-9ebe-d15ee29f1c10",
"db_currency_id": "ec5efd6b-c9da-4f6f-a7e3-f8ad0486c44b",
"db_language_id": "35866b2b-2e81-44a7-a7f3-cdb05927fa91",
"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-05-21T19:21:41.4495247+00:00"
},
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00"
},
"equipment_family_id": "4e36d377-ee55-4ffd-9695-e1ec8975e7f7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d0b507a6-605d-4f2c-8068-8f2f2ec863fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1bdca7fb-2ef4-46a1-bce3-3e9c1dcd33c2",
"_parent_code": "sample string 6",
"sales_organization_id": "3e84a80c-48de-4b30-a60b-f2aa23ee4dac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5337bd78-c937-428b-9c03-15d34b9ca2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b82485fd-249f-4a8f-9ebe-d15ee29f1c10",
"db_currency_id": "ec5efd6b-c9da-4f6f-a7e3-f8ad0486c44b",
"db_language_id": "35866b2b-2e81-44a7-a7f3-cdb05927fa91",
"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-05-21T19:21:41.4495247+00:00"
},
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00"
},
"date_in_production_since": "2026-05-21T19:21:41.4495247+00:00",
"date_out_of_production_since": "2026-05-21T19:21:41.4495247+00:00",
"date_end_support": "2026-05-21T19:21:41.4495247+00:00",
"sales_organization_id": "cde097f5-5e1b-4d6e-86de-fa882a955e5d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5337bd78-c937-428b-9c03-15d34b9ca2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b82485fd-249f-4a8f-9ebe-d15ee29f1c10",
"db_currency_id": "ec5efd6b-c9da-4f6f-a7e3-f8ad0486c44b",
"db_language_id": "35866b2b-2e81-44a7-a7f3-cdb05927fa91",
"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-05-21T19:21:41.4495247+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-05-21T19:21:41.4495247+00:00"
},
"project_status_id": "3969c03a-ea15-4fb7-88bc-02e6df3eca65",
"project_status_code": "sample string 10",
"project_status": {
"id": "5c422bc0-4998-4d61-8ce7-8966dc623178",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a0d491a2-8cf6-4e16-a76b-e80d76f3da96",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5337bd78-c937-428b-9c03-15d34b9ca2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b82485fd-249f-4a8f-9ebe-d15ee29f1c10",
"db_currency_id": "ec5efd6b-c9da-4f6f-a7e3-f8ad0486c44b",
"db_language_id": "35866b2b-2e81-44a7-a7f3-cdb05927fa91",
"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-05-21T19:21:41.4495247+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00"
},
"company_id": "f6988954-7ac8-4f41-9fce-7d3ecc7b173e",
"company_code": "sample string 12",
"db_address_id": "01a29b94-e014-4340-93ea-6a81c7799158",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "308c10ce-5f77-47b9-9f0b-16702bbcdd92",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "622f0105-a442-40f9-a489-b30881082fbf",
"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-05-21T19:21:41.4495247+00:00",
"date_create": "2026-05-21T19:21:41.4495247+00:00",
"date_update": "2026-05-21T19:21:41.4495247+00:00",
"updated_by_user_id": "034a2b5f-c6eb-4e98-8ee6-d722dc1cbecc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-21T19:21:41.4495247+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-05-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-21T19:21:41.4495247+00:00",
"date_last_job": "2026-05-21T19:21:41.4495247+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-21T19:21:41.4495247+00:00",
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00",
"is_mobile_installation": true
},
"job_type_id": "a295b8b0-0ba3-4d60-971f-82d8b8f6d90b",
"job_type_code": "sample string 7",
"job_type": {
"id": "a2ced36c-c6cc-47a2-951f-1855ddc3cdd5",
"name": "sample string 2",
"sales_organization_id": "223add34-6406-44d1-a9dd-f0f833e5f4a2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00",
"code": "sample string 7"
},
"job_priority_id": "08566234-cb6e-4c38-971c-14d1256f2efb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d6768b70-f0c6-4d35-9885-96f918002532",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bf378cea-0c65-415b-87ea-4444eb2b82a6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5337bd78-c937-428b-9c03-15d34b9ca2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b82485fd-249f-4a8f-9ebe-d15ee29f1c10",
"db_currency_id": "ec5efd6b-c9da-4f6f-a7e3-f8ad0486c44b",
"db_language_id": "35866b2b-2e81-44a7-a7f3-cdb05927fa91",
"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-05-21T19:21:41.4495247+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00"
},
"job_status_id": "735c34e4-1994-4fc4-b40b-2c82c8fcc3fb",
"job_status_code": "sample string 11",
"db_address_id": "56147f5a-b4bf-4852-9365-dd81f60e9bbd",
"contact_id": "a21cdfac-d7a8-49e8-911e-a7d0555adc04",
"requested_by_company_id": "658cc125-1c4e-4c8f-8007-8d847098d7ba",
"requested_by_contact_id": "c9136c89-e2bc-4c50-8368-49304ec46243",
"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-05-21T19:21:41.4495247+00:00",
"due_date": "2026-05-21T19:21:41.4495247+00:00",
"date_create": "2026-05-21T19:21:41.4495247+00:00",
"date_update": "2026-05-21T19:21:41.4495247+00:00",
"date_closed": "2026-05-21T19:21:41.4495247+00:00",
"suggested_user_id": "649ee34c-564f-4f50-9472-1fcb9796023e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a22a7202-08d8-4018-97b1-041c89d6b80e",
"db_language_id": "76bc331a-e5e4-419e-a0fe-405289ba14e3",
"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-05-21T19:21:41.4495247+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "60bb864e-4a82-449a-b68b-d053e2d1ac5b",
"sales_organization": {
"id": "5337bd78-c937-428b-9c03-15d34b9ca2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b82485fd-249f-4a8f-9ebe-d15ee29f1c10",
"db_currency_id": "ec5efd6b-c9da-4f6f-a7e3-f8ad0486c44b",
"db_language_id": "35866b2b-2e81-44a7-a7f3-cdb05927fa91",
"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-05-21T19:21:41.4495247+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b4425bb2-5f07-4606-bd19-3a12565e4964",
"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": "a071392e-6e2a-42a1-b72b-f4fb2db4dd69",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0144fb80-451f-4a6e-89ce-685435ea2fe4"
},
"suggested_date_start": "2026-05-21T19:21:41.4495247+00:00",
"skill_id": "53d276e7-9e8b-48f7-9a27-3ce655fb6a36",
"skill_code": "sample string 32",
"skill": {
"id": "debc086f-155d-4ec0-b32f-3d2d68029404",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ee8bb2f1-b825-425f-8d54-0ab6f1708b51",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5337bd78-c937-428b-9c03-15d34b9ca2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b82485fd-249f-4a8f-9ebe-d15ee29f1c10",
"db_currency_id": "ec5efd6b-c9da-4f6f-a7e3-f8ad0486c44b",
"db_language_id": "35866b2b-2e81-44a7-a7f3-cdb05927fa91",
"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-05-21T19:21:41.4495247+00:00"
},
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1a455c0a-d9b8-4eac-ab44-9d4d3b1dcf58",
"date_reported_by_company": "2026-05-21T19:21:41.4495247+00:00",
"id2": 36,
"company_id": "d5d9a493-a820-4022-8adc-d8952a5177bc",
"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": "1b402ed1-3421-406e-abf3-e025d319b707",
"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-05-21T19:21:41.4495247+00:00"
},
"work_instruction_details_id": "9df1d147-0902-4e7d-9191-93ce0d333909",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b683ddfe-39eb-467b-8dcc-0010ebbff75c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eff147ca-0153-4eaa-8646-0d44242240a0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-21T19:21:41.4495247+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": "e581028a-e13c-4a0b-ac81-4ec8888f552c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-21T19:21:41.4495247+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.