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": "bca51d62-b697-4cb4-a4fa-8b4ac608f777",
"jobs_id": "19798cd6-706d-4e27-9ded-f22821eb2b89",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e9850fb0-1f35-4014-b78e-960e977a2733",
"_parent_id": "017cc2a2-c530-48f6-bcd8-03fec4b0ef2f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fc030eff-e1c6-4826-bcd9-79ec21251e0a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1c98d51a-3c83-456d-bf97-d15ee83a8e80",
"_parent_id": "b94b5846-def3-48c8-bd2f-ed61dded7bda",
"root_parent_id": "02ef3432-8478-44c0-9127-9c8581987f0a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e228719-4143-4ef5-8a07-41274493d3c3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "08a7babe-3b7c-47ec-a1ec-ccb72d048013",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3cfd424a-413f-4bba-89e2-708e4cdf97f3",
"_parent_code": "sample string 6",
"sales_organization_id": "9f4e6d80-53f8-41bc-85ef-ebf68b8dac41",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5b67b0e5-e34b-41fc-94b6-23759c83b216",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09affc62-4ae6-4fd3-babe-f1f4c1c532ce",
"db_currency_id": "11d87a97-d3db-4df9-a2f6-bd9f78d095e8",
"db_language_id": "4c169619-7040-455b-bfcf-0fc5a8098e11",
"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-05T08:31:07.3775606+00:00"
},
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00"
},
"equipment_model_id": "e5ba8529-7559-4760-b8e8-700037d9f88a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0a8ead61-6e38-494a-aabb-d206bace13fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c1b402e5-0f4f-4824-b7e8-ddcf12d5a930",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1124815e-d45b-464f-bf01-77e7ca8cd639",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "808e36f8-fde7-440e-86b0-81885db6b994",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5b67b0e5-e34b-41fc-94b6-23759c83b216",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09affc62-4ae6-4fd3-babe-f1f4c1c532ce",
"db_currency_id": "11d87a97-d3db-4df9-a2f6-bd9f78d095e8",
"db_language_id": "4c169619-7040-455b-bfcf-0fc5a8098e11",
"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-05T08:31:07.3775606+00:00"
},
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00"
},
"equipment_family_id": "d6a18d37-eb71-4e32-9f23-920630e19271",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "08a7babe-3b7c-47ec-a1ec-ccb72d048013",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3cfd424a-413f-4bba-89e2-708e4cdf97f3",
"_parent_code": "sample string 6",
"sales_organization_id": "9f4e6d80-53f8-41bc-85ef-ebf68b8dac41",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5b67b0e5-e34b-41fc-94b6-23759c83b216",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09affc62-4ae6-4fd3-babe-f1f4c1c532ce",
"db_currency_id": "11d87a97-d3db-4df9-a2f6-bd9f78d095e8",
"db_language_id": "4c169619-7040-455b-bfcf-0fc5a8098e11",
"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-05T08:31:07.3775606+00:00"
},
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00"
},
"date_in_production_since": "2026-07-05T08:31:07.3775606+00:00",
"date_out_of_production_since": "2026-07-05T08:31:07.3775606+00:00",
"date_end_support": "2026-07-05T08:31:07.3775606+00:00",
"sales_organization_id": "55b5b789-b161-4e46-a46e-fdeac6692580",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5b67b0e5-e34b-41fc-94b6-23759c83b216",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09affc62-4ae6-4fd3-babe-f1f4c1c532ce",
"db_currency_id": "11d87a97-d3db-4df9-a2f6-bd9f78d095e8",
"db_language_id": "4c169619-7040-455b-bfcf-0fc5a8098e11",
"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-05T08:31:07.3775606+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-05T08:31:07.3775606+00:00"
},
"project_status_id": "198e6573-9386-48f8-a072-58db9006af69",
"project_status_code": "sample string 10",
"project_status": {
"id": "3c6ff1da-580c-449b-a045-936cc4e16f80",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "679bdd56-2c71-40c8-bd4a-c58b83c58388",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5b67b0e5-e34b-41fc-94b6-23759c83b216",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09affc62-4ae6-4fd3-babe-f1f4c1c532ce",
"db_currency_id": "11d87a97-d3db-4df9-a2f6-bd9f78d095e8",
"db_language_id": "4c169619-7040-455b-bfcf-0fc5a8098e11",
"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-05T08:31:07.3775606+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00"
},
"company_id": "c9189785-63da-442f-a203-d78dc4f2d70d",
"company_code": "sample string 12",
"db_address_id": "45f3f818-f4b2-4407-8883-9615fb6f6ee8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "85323c71-83d9-469e-8c01-9079fcb03bbd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3baa9ff8-0184-4744-8a60-fbb1a2cd2e5a",
"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-05T08:31:07.3775606+00:00",
"date_create": "2026-07-05T08:31:07.3775606+00:00",
"date_update": "2026-07-05T08:31:07.3775606+00:00",
"updated_by_user_id": "b9e977c2-9298-4c65-8724-aaf1282851e0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-05T08:31:07.3775606+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-05T08:31:07.3775606+00:00",
"date_last_job": "2026-07-05T08:31:07.3775606+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-05T08:31:07.3775606+00:00",
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00",
"is_mobile_installation": true
},
"job_type_id": "4babc252-cd8c-4383-8a38-d33308488725",
"job_type_code": "sample string 7",
"job_type": {
"id": "88cb3dc5-acb6-4541-9e41-6034d20ce5b4",
"name": "sample string 2",
"sales_organization_id": "7265740b-a49d-4a4f-97bd-4a3e6fbeabbf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00",
"code": "sample string 7"
},
"job_priority_id": "99b9e496-24e4-40d3-90d3-0defb5d429eb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4bf05e8f-eed1-4d08-a8ea-b9541b7ba1f7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6cfb0a5c-c96b-46ab-9337-cfc3c8bfd4d9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5b67b0e5-e34b-41fc-94b6-23759c83b216",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09affc62-4ae6-4fd3-babe-f1f4c1c532ce",
"db_currency_id": "11d87a97-d3db-4df9-a2f6-bd9f78d095e8",
"db_language_id": "4c169619-7040-455b-bfcf-0fc5a8098e11",
"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-05T08:31:07.3775606+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00"
},
"job_status_id": "e5dac0ab-a52b-47fb-8f90-e3a85e989c6e",
"job_status_code": "sample string 11",
"db_address_id": "2002de3d-c207-4448-b933-d2feddd6328e",
"contact_id": "c120a3b0-2837-4f03-973c-696f819449a3",
"requested_by_company_id": "e225d530-6a9a-4cb9-8825-5fc2d9b53435",
"requested_by_contact_id": "bb2232a9-4519-4ce2-8f87-479e30e61710",
"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-05T08:31:07.3775606+00:00",
"due_date": "2026-07-05T08:31:07.3775606+00:00",
"date_create": "2026-07-05T08:31:07.3775606+00:00",
"date_update": "2026-07-05T08:31:07.3775606+00:00",
"date_closed": "2026-07-05T08:31:07.3775606+00:00",
"suggested_user_id": "769c0254-c84a-4ff2-92f5-13712a2029c1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c745f059-a0a8-46b0-b0ae-6038a211702e",
"db_language_id": "ad90636d-2185-4422-bbfc-064920d1f11a",
"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-05T08:31:07.3775606+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3af20989-e85e-4046-89ec-fc4f5933e762",
"sales_organization": {
"id": "5b67b0e5-e34b-41fc-94b6-23759c83b216",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09affc62-4ae6-4fd3-babe-f1f4c1c532ce",
"db_currency_id": "11d87a97-d3db-4df9-a2f6-bd9f78d095e8",
"db_language_id": "4c169619-7040-455b-bfcf-0fc5a8098e11",
"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-05T08:31:07.3775606+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "59128679-c150-4f8f-bd06-e48d6e686025",
"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": "3bb623d0-5965-46e5-90d3-6ebf18bfe400",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "02aed0b8-1d7f-4042-9e13-95ac10a6e0c1"
},
"suggested_date_start": "2026-07-05T08:31:07.3775606+00:00",
"skill_id": "8966b48b-2243-4106-a12b-1456992c9944",
"skill_code": "sample string 32",
"skill": {
"id": "a96dd6ad-b0d6-4141-b5c6-d94e811b8232",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "54415906-63ee-49e8-b92e-ef3e73859e8d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5b67b0e5-e34b-41fc-94b6-23759c83b216",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09affc62-4ae6-4fd3-babe-f1f4c1c532ce",
"db_currency_id": "11d87a97-d3db-4df9-a2f6-bd9f78d095e8",
"db_language_id": "4c169619-7040-455b-bfcf-0fc5a8098e11",
"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-05T08:31:07.3775606+00:00"
},
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "58d2731a-2d84-4b95-92be-2329891eeb37",
"date_reported_by_company": "2026-07-05T08:31:07.3775606+00:00",
"id2": 36,
"company_id": "ced050e0-02fe-4fc5-a9a3-e35b547616b6",
"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": "a26efe37-753b-4ac8-8b53-7d3c9d60b534",
"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-05T08:31:07.3775606+00:00"
},
"work_instruction_details_id": "0fe386c1-99c4-44a5-9a16-ccfc168af647",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "11f3aedc-e985-4e9a-b13c-365b81364cb8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5048658e-672e-42b3-9eff-c99878cf4f57",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-05T08:31:07.3775606+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": "579c5070-1eae-4770-918e-a49c3df5eed4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-05T08:31:07.3775606+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.