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": "61695a3c-bea3-4700-8fa9-f231c9c3282a",
"jobs_id": "fba64581-0c7f-434d-ac79-2e3c2ee878bd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "557e969f-6bca-4e7e-9248-fd21b1a4db8a",
"_parent_id": "aaa9b017-5b92-4f14-9508-18eea1a59611",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "78c25df4-2342-44df-ab48-dee85ec52ab0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a2639849-5f9c-4415-b884-f2e55b212f18",
"_parent_id": "7715357c-318c-40e5-907f-23367853c073",
"root_parent_id": "4d8529c2-da18-41b5-a2eb-6a27592ccddd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9b99f711-1cfa-4fad-996c-8cf26824de1b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6481d231-8a3d-4424-a093-910e1bac2d40",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "08f4f3fa-7100-4a0f-ad61-9ef518a6ce67",
"_parent_code": "sample string 6",
"sales_organization_id": "b2bd3120-5612-499d-a761-174c821172c0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3d7cb5e0-3482-471a-9202-a4036fff2304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43b83361-b7dd-46e8-8a03-828310371ee3",
"db_currency_id": "b6638d2f-3c47-4db0-819d-2219be0a2991",
"db_language_id": "c58931f5-09c4-465b-a8f0-cb3bce453522",
"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-01-23T10:18:07.8925138+00:00"
},
"modified_dateutc": "2026-01-23T10:18:07.8925138+00:00"
},
"equipment_model_id": "d7ccd536-d4ec-44f8-9a31-ea7c8fecf138",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "29c31929-1daf-4520-a3ca-d201037d8fa8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dca3cde1-5837-41b5-bd38-c6c087643398",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "204ce0f6-dace-4422-bc64-04aae6f9813a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f606ffa6-2b5f-4de4-a4a5-027bdbdafc53",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d7cb5e0-3482-471a-9202-a4036fff2304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43b83361-b7dd-46e8-8a03-828310371ee3",
"db_currency_id": "b6638d2f-3c47-4db0-819d-2219be0a2991",
"db_language_id": "c58931f5-09c4-465b-a8f0-cb3bce453522",
"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-01-23T10:18:07.8925138+00:00"
},
"modified_dateutc": "2026-01-23T10:18:07.8925138+00:00"
},
"equipment_family_id": "93c961e8-d3f5-4427-aceb-53288a6988a2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6481d231-8a3d-4424-a093-910e1bac2d40",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "08f4f3fa-7100-4a0f-ad61-9ef518a6ce67",
"_parent_code": "sample string 6",
"sales_organization_id": "b2bd3120-5612-499d-a761-174c821172c0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3d7cb5e0-3482-471a-9202-a4036fff2304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43b83361-b7dd-46e8-8a03-828310371ee3",
"db_currency_id": "b6638d2f-3c47-4db0-819d-2219be0a2991",
"db_language_id": "c58931f5-09c4-465b-a8f0-cb3bce453522",
"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-01-23T10:18:07.8925138+00:00"
},
"modified_dateutc": "2026-01-23T10:18:07.8925138+00:00"
},
"date_in_production_since": "2026-01-23T10:18:07.8925138+00:00",
"date_out_of_production_since": "2026-01-23T10:18:07.8925138+00:00",
"date_end_support": "2026-01-23T10:18:07.8925138+00:00",
"sales_organization_id": "41fcc9e9-4c05-410b-837a-018a35908849",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3d7cb5e0-3482-471a-9202-a4036fff2304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43b83361-b7dd-46e8-8a03-828310371ee3",
"db_currency_id": "b6638d2f-3c47-4db0-819d-2219be0a2991",
"db_language_id": "c58931f5-09c4-465b-a8f0-cb3bce453522",
"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-01-23T10:18:07.8925138+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-01-23T10:18:07.8925138+00:00"
},
"project_status_id": "0a603b95-4bf4-4b60-9789-03664e382dc8",
"project_status_code": "sample string 10",
"project_status": {
"id": "3b245845-09a2-4c44-845c-ba4b0c082bd7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2bd002b9-2f78-4685-b00b-f5f38b4ea0fa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d7cb5e0-3482-471a-9202-a4036fff2304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43b83361-b7dd-46e8-8a03-828310371ee3",
"db_currency_id": "b6638d2f-3c47-4db0-819d-2219be0a2991",
"db_language_id": "c58931f5-09c4-465b-a8f0-cb3bce453522",
"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-01-23T10:18:07.8925138+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-23T10:18:07.8925138+00:00"
},
"company_id": "4227c4bc-7264-4ae5-8e41-08538e096d96",
"company_code": "sample string 12",
"db_address_id": "2d7273e6-c1dd-4e0c-bd49-9143ec818a2b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "425a5053-0263-4c36-a245-c174fbc94a14",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0e75612e-87ed-44af-b9b9-dc9b7966a27a",
"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-01-23T10:18:07.8925138+00:00",
"date_create": "2026-01-23T10:18:07.8925138+00:00",
"date_update": "2026-01-23T10:18:07.8925138+00:00",
"updated_by_user_id": "c9d61a0e-fbbc-42e2-bebf-97b81bea4873",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-23T10:18:07.8925138+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-01-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-23T10:18:07.8925138+00:00",
"date_last_job": "2026-01-23T10:18:07.8925138+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-23T10:18:07.8925138+00:00",
"modified_dateutc": "2026-01-23T10:18:07.8925138+00:00",
"is_mobile_installation": true
},
"job_type_id": "f5d263fa-89aa-4cd6-b1a0-c86be65e1a89",
"job_type_code": "sample string 7",
"job_type": {
"id": "eba26afc-9f70-48db-9774-68ea3c315fa1",
"name": "sample string 2",
"sales_organization_id": "beec96c3-0af3-4c7c-bd85-cd7bd36536ec",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-23T10:18:07.8925138+00:00",
"code": "sample string 7"
},
"job_priority_id": "c49eee4a-1d37-486c-bcc7-65f29a772527",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2e58faf7-6d2f-4f35-9a59-8dcac6ffe688",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "133a9748-8150-4ad0-8690-757db1d30fca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d7cb5e0-3482-471a-9202-a4036fff2304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43b83361-b7dd-46e8-8a03-828310371ee3",
"db_currency_id": "b6638d2f-3c47-4db0-819d-2219be0a2991",
"db_language_id": "c58931f5-09c4-465b-a8f0-cb3bce453522",
"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-01-23T10:18:07.8925138+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-23T10:18:07.8925138+00:00"
},
"job_status_id": "8a132561-88f4-485e-a91c-8c105a4afcbc",
"job_status_code": "sample string 11",
"db_address_id": "a83c3f16-7e99-48e3-877b-797be8bc3f07",
"contact_id": "e805f0c5-83f7-4203-9338-786eb3229f17",
"requested_by_company_id": "b34f052d-825a-467a-a535-63e2b80348d9",
"requested_by_contact_id": "84dbf931-aa6f-47a6-a21f-abbe66de4d08",
"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-01-23T10:18:07.8925138+00:00",
"due_date": "2026-01-23T10:18:07.9081435+00:00",
"date_create": "2026-01-23T10:18:07.9081435+00:00",
"date_update": "2026-01-23T10:18:07.9081435+00:00",
"date_closed": "2026-01-23T10:18:07.9081435+00:00",
"suggested_user_id": "336a276f-7fe2-4771-b9f8-43a512ce1fa0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "97047e03-e3ca-41b0-bc4b-3efa5a89918c",
"db_language_id": "822c0d07-6782-4e5b-a4e2-816e86bda6e7",
"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-01-23T10:18:07.9081435+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a5ed57d5-5a00-4c12-8cf7-df47b8d87be3",
"sales_organization": {
"id": "3d7cb5e0-3482-471a-9202-a4036fff2304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43b83361-b7dd-46e8-8a03-828310371ee3",
"db_currency_id": "b6638d2f-3c47-4db0-819d-2219be0a2991",
"db_language_id": "c58931f5-09c4-465b-a8f0-cb3bce453522",
"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-01-23T10:18:07.8925138+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c137febb-7f15-475e-b725-57c9eb235c6f",
"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": "45870037-f809-4bb0-8843-e4d7d95c9a28",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-23T10:18:07.9081435+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8ea2b4e0-a104-4534-b58d-d522c8de6e20"
},
"suggested_date_start": "2026-01-23T10:18:07.9081435+00:00",
"skill_id": "53d0b875-2667-4405-bb75-ca8672a61026",
"skill_code": "sample string 32",
"skill": {
"id": "898d5d52-30a7-42e2-82ae-37f965dc2e5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b95053e3-9b06-4976-9020-761cf9c6d6ef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3d7cb5e0-3482-471a-9202-a4036fff2304",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43b83361-b7dd-46e8-8a03-828310371ee3",
"db_currency_id": "b6638d2f-3c47-4db0-819d-2219be0a2991",
"db_language_id": "c58931f5-09c4-465b-a8f0-cb3bce453522",
"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-01-23T10:18:07.8925138+00:00"
},
"modified_dateutc": "2026-01-23T10:18:07.9081435+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c5fb6b06-deb6-400a-a2a8-dd11a7015c44",
"date_reported_by_company": "2026-01-23T10:18:07.9081435+00:00",
"id2": 36,
"company_id": "d6370c5d-5782-4097-b5dc-618a5e4bc425",
"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": "907a065f-e546-4542-be77-ebaac6e812af",
"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-01-23T10:18:07.9081435+00:00"
},
"work_instruction_details_id": "9956b6fe-fffd-43f5-8c1f-2cd6c630932f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5bf52616-6a1f-4fd9-a54b-0ebf5c79b350",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3c749a96-f6e1-43c6-b1a7-f3f6e66e3fcc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-23T10:18:07.9081435+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": "43d49ce7-1151-4a36-8bce-8d1fb283134d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-23T10:18:07.9081435+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.