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": "3a04dee9-3a82-4394-8b9f-d01d81c9b6f7",
"jobs_id": "6f950654-07b8-499e-93be-d56e8c0bd61a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6d442d0b-9426-439e-8abe-52b57ca6b0ef",
"_parent_id": "e1635776-5978-4385-866b-4290c414aa80",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f3349fff-e157-4f90-bd61-de1fbbad492f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "45acccc5-db6d-4e3d-ab22-8c1a8e2b8a42",
"_parent_id": "368ae4d8-cafe-4120-b737-d36b8eacf97f",
"root_parent_id": "1f1ca89f-84b5-4e90-ae92-29d847f2ff74",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2efc6630-3d6b-4981-af94-bd5fa8aef501",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "73586e13-fb2d-4c89-9950-472ec34e1cbc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01fff2c0-6800-43df-9a7a-301f63501c1c",
"_parent_code": "sample string 6",
"sales_organization_id": "d3d25c39-d09c-41cc-929a-64adfe4ba0f6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2a68d07-a239-4891-b6f9-43b25ceed3be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19fa475a-8748-4fdd-8040-75bc339bb4b5",
"db_currency_id": "80e713a9-f68b-4e6c-baf0-c93856a616df",
"db_language_id": "a1e57545-98ea-4341-a0c1-bbc3efcb3595",
"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-09-28T18:17:16.6304056+00:00"
},
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00"
},
"equipment_model_id": "c852ea74-ad6d-45bf-96bf-82c28841b881",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0034dace-6d71-4f3f-87ca-e96f94a93c55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5b6f5bb1-c379-44ab-ad67-011d54d7906d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7fe7745f-c387-43b6-92b2-a096cf7bf352",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1e76846f-a712-48c3-a987-0e1345049eda",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a2a68d07-a239-4891-b6f9-43b25ceed3be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19fa475a-8748-4fdd-8040-75bc339bb4b5",
"db_currency_id": "80e713a9-f68b-4e6c-baf0-c93856a616df",
"db_language_id": "a1e57545-98ea-4341-a0c1-bbc3efcb3595",
"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-09-28T18:17:16.6304056+00:00"
},
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00"
},
"equipment_family_id": "671df071-3a99-4601-9d58-4f59d2c82289",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "73586e13-fb2d-4c89-9950-472ec34e1cbc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01fff2c0-6800-43df-9a7a-301f63501c1c",
"_parent_code": "sample string 6",
"sales_organization_id": "d3d25c39-d09c-41cc-929a-64adfe4ba0f6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2a68d07-a239-4891-b6f9-43b25ceed3be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19fa475a-8748-4fdd-8040-75bc339bb4b5",
"db_currency_id": "80e713a9-f68b-4e6c-baf0-c93856a616df",
"db_language_id": "a1e57545-98ea-4341-a0c1-bbc3efcb3595",
"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-09-28T18:17:16.6304056+00:00"
},
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00"
},
"date_in_production_since": "2026-09-28T18:17:16.6304056+00:00",
"date_out_of_production_since": "2026-09-28T18:17:16.6304056+00:00",
"date_end_support": "2026-09-28T18:17:16.6304056+00:00",
"sales_organization_id": "610a825b-fed9-488f-be7e-21ea31fd8186",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a2a68d07-a239-4891-b6f9-43b25ceed3be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19fa475a-8748-4fdd-8040-75bc339bb4b5",
"db_currency_id": "80e713a9-f68b-4e6c-baf0-c93856a616df",
"db_language_id": "a1e57545-98ea-4341-a0c1-bbc3efcb3595",
"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-09-28T18:17:16.6304056+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-09-28T18:17:16.6304056+00:00"
},
"project_status_id": "63957ef7-b92f-4c76-ba09-5b3af1894700",
"project_status_code": "sample string 10",
"project_status": {
"id": "6cffb1ac-2398-4157-a687-3176bac2803f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "34acc1b4-bc3d-4063-91bc-d29f1dcd148b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2a68d07-a239-4891-b6f9-43b25ceed3be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19fa475a-8748-4fdd-8040-75bc339bb4b5",
"db_currency_id": "80e713a9-f68b-4e6c-baf0-c93856a616df",
"db_language_id": "a1e57545-98ea-4341-a0c1-bbc3efcb3595",
"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-09-28T18:17:16.6304056+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00"
},
"company_id": "b8ad8de0-ea6c-4c47-862f-456dbf8a96e4",
"company_code": "sample string 12",
"db_address_id": "a3e35ac3-e4df-4db7-b039-696aa7ed7d3b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8690d050-03b4-49ae-9474-f24426efcad0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1efdbd89-815a-47fc-929b-1ef1270b9077",
"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-09-28T18:17:16.6304056+00:00",
"date_create": "2026-09-28T18:17:16.6304056+00:00",
"date_update": "2026-09-28T18:17:16.6304056+00:00",
"updated_by_user_id": "24cb8581-7cfe-4ca0-af41-277fe14073bf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-28T18:17:16.6304056+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-09-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-28T18:17:16.6304056+00:00",
"date_last_job": "2026-09-28T18:17:16.6304056+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-28T18:17:16.6304056+00:00",
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00",
"is_mobile_installation": true
},
"job_type_id": "72f7d6db-1dd4-4a3f-b362-e17a251fbcb9",
"job_type_code": "sample string 7",
"job_type": {
"id": "787d9390-3320-4f40-b80a-2d37ea45304f",
"name": "sample string 2",
"sales_organization_id": "bb77d559-83a5-4c2f-bade-bb4bb70d9aa3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00",
"code": "sample string 7"
},
"job_priority_id": "c0c34a4e-32c0-4c89-8284-c6892987e060",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4451c4d3-693b-4a43-af79-fe8123fa5b8b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "697fffc8-58dd-4d78-a1ba-4ceb85f33de3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2a68d07-a239-4891-b6f9-43b25ceed3be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19fa475a-8748-4fdd-8040-75bc339bb4b5",
"db_currency_id": "80e713a9-f68b-4e6c-baf0-c93856a616df",
"db_language_id": "a1e57545-98ea-4341-a0c1-bbc3efcb3595",
"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-09-28T18:17:16.6304056+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00"
},
"job_status_id": "a0a9a652-ca6b-4179-a681-759d7ce3f78e",
"job_status_code": "sample string 11",
"db_address_id": "461c1ad2-58e1-411e-88a3-48c00794e950",
"contact_id": "7bbd0b94-a1a6-43f4-95d1-900880becac2",
"requested_by_company_id": "6232ac1d-8319-485c-b2a1-35c639d49c52",
"requested_by_contact_id": "b3661dc0-ae47-4d47-bc80-e79cbdf44823",
"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-09-28T18:17:16.6304056+00:00",
"due_date": "2026-09-28T18:17:16.6304056+00:00",
"date_create": "2026-09-28T18:17:16.6304056+00:00",
"date_update": "2026-09-28T18:17:16.6304056+00:00",
"date_closed": "2026-09-28T18:17:16.6304056+00:00",
"suggested_user_id": "0009f070-e58d-4108-a1fa-16ec7fdcd2c3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fff1526e-49ff-44ee-a7aa-016afd8b05eb",
"db_language_id": "5335ac9f-13c2-4d16-8511-2590bcabd5cb",
"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-09-28T18:17:16.6304056+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0e5e1f9f-1230-403f-a495-37e8f737b0e9",
"sales_organization": {
"id": "a2a68d07-a239-4891-b6f9-43b25ceed3be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19fa475a-8748-4fdd-8040-75bc339bb4b5",
"db_currency_id": "80e713a9-f68b-4e6c-baf0-c93856a616df",
"db_language_id": "a1e57545-98ea-4341-a0c1-bbc3efcb3595",
"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-09-28T18:17:16.6304056+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c711064b-3ce8-43c4-a944-ede95924876c",
"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": "a2775f18-c20b-4ee8-8285-b6146b280ea6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a0086539-25fe-4af5-9458-64cb47b7859f"
},
"suggested_date_start": "2026-09-28T18:17:16.6304056+00:00",
"skill_id": "e1c21601-695e-4602-ac95-5f3c0a37d652",
"skill_code": "sample string 32",
"skill": {
"id": "4cbcc8ae-a3c0-4b9a-b8cc-706dd82d0f7f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e0e20ad6-db7e-4419-b9d6-cf0d3fda408d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2a68d07-a239-4891-b6f9-43b25ceed3be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19fa475a-8748-4fdd-8040-75bc339bb4b5",
"db_currency_id": "80e713a9-f68b-4e6c-baf0-c93856a616df",
"db_language_id": "a1e57545-98ea-4341-a0c1-bbc3efcb3595",
"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-09-28T18:17:16.6304056+00:00"
},
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3d985b9d-2ae7-4c45-aaf4-51c9329c8f4d",
"date_reported_by_company": "2026-09-28T18:17:16.6304056+00:00",
"id2": 36,
"company_id": "fbcf89b6-23d4-4eda-8ecc-3dfd6ecb27d4",
"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": "76b6d617-78c8-4479-8edf-79a533abec7c",
"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-09-28T18:17:16.6304056+00:00"
},
"work_instruction_details_id": "2b700e0c-f245-42bb-bcf1-e7b1e2519e27",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c51338cc-9547-4f6d-a759-0fb852f25e11",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ab0bfadc-78fa-47d3-aae5-d4cc374c57f2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-28T18:17:16.6304056+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": "d591cc64-0f77-4879-be8a-7f8a63292284",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-28T18:17:16.6304056+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.