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": "feb14817-da07-4020-8037-49be75d55025",
"jobs_id": "2a0f96b3-ec0f-415f-811c-e27e8e72edf6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "acced9a2-d335-4008-9142-6b2d126c2876",
"_parent_id": "ad0df290-12b0-40ce-9515-df2a4aab0c17",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fbe240cf-4de0-475c-95ef-37b597b6c108",
"project_reference_back_office": "sample string 5",
"project": {
"id": "31d753a1-269a-4867-b7e4-ba0e7b45a0c8",
"_parent_id": "5dc57686-dcc9-484c-9221-49611fc0941a",
"root_parent_id": "409d2120-f8a8-460e-a156-f2dc13ad1562",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0358c848-ecf3-4aea-b0d6-6c095acc03b8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2d1e000b-18be-4c1d-a7a6-fbd1e649866c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc2797e9-bc3c-4ff1-aeb7-4d578184bf2d",
"_parent_code": "sample string 6",
"sales_organization_id": "0b59db67-245a-4b99-b6cf-4d5008e9a0c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f90bf511-bfcb-4599-892e-28339f3040b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e50f5d7f-8682-4381-b5d7-7f6098c2e2fb",
"db_currency_id": "c7ce082f-2ddf-48bb-b4b5-4f51c8d86149",
"db_language_id": "9630efe6-896d-4c04-bd77-ed7f0fcd4b11",
"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-26T21:10:47.1563206+00:00"
},
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00"
},
"equipment_model_id": "6f8464db-fb9a-48ea-b737-3c360b785c6a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "973c83c2-fd23-4e29-9f66-28b27048eb0b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ceeaa6e3-7b69-45bb-b76d-32d7cf3cf60b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "602afe3e-5f4b-41a0-a634-d35a4a746a74",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2cff9f10-2473-4538-a40e-3a535fe6b678",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f90bf511-bfcb-4599-892e-28339f3040b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e50f5d7f-8682-4381-b5d7-7f6098c2e2fb",
"db_currency_id": "c7ce082f-2ddf-48bb-b4b5-4f51c8d86149",
"db_language_id": "9630efe6-896d-4c04-bd77-ed7f0fcd4b11",
"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-26T21:10:47.1563206+00:00"
},
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00"
},
"equipment_family_id": "93613d9b-fb10-48ea-a83d-b9f6213d2f46",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2d1e000b-18be-4c1d-a7a6-fbd1e649866c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc2797e9-bc3c-4ff1-aeb7-4d578184bf2d",
"_parent_code": "sample string 6",
"sales_organization_id": "0b59db67-245a-4b99-b6cf-4d5008e9a0c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f90bf511-bfcb-4599-892e-28339f3040b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e50f5d7f-8682-4381-b5d7-7f6098c2e2fb",
"db_currency_id": "c7ce082f-2ddf-48bb-b4b5-4f51c8d86149",
"db_language_id": "9630efe6-896d-4c04-bd77-ed7f0fcd4b11",
"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-26T21:10:47.1563206+00:00"
},
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00"
},
"date_in_production_since": "2026-01-26T21:10:47.1563206+00:00",
"date_out_of_production_since": "2026-01-26T21:10:47.1563206+00:00",
"date_end_support": "2026-01-26T21:10:47.1563206+00:00",
"sales_organization_id": "463a2e08-7c45-4e32-b1a5-e26bbcf2afc6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f90bf511-bfcb-4599-892e-28339f3040b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e50f5d7f-8682-4381-b5d7-7f6098c2e2fb",
"db_currency_id": "c7ce082f-2ddf-48bb-b4b5-4f51c8d86149",
"db_language_id": "9630efe6-896d-4c04-bd77-ed7f0fcd4b11",
"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-26T21:10:47.1563206+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-26T21:10:47.1563206+00:00"
},
"project_status_id": "0281da6a-9a1a-48b7-aa12-a40d0396e4ff",
"project_status_code": "sample string 10",
"project_status": {
"id": "4689680b-ef0c-48b5-89a0-69907bc1b124",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "558acdc2-7062-4c2b-a7c8-77b8ee66811e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f90bf511-bfcb-4599-892e-28339f3040b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e50f5d7f-8682-4381-b5d7-7f6098c2e2fb",
"db_currency_id": "c7ce082f-2ddf-48bb-b4b5-4f51c8d86149",
"db_language_id": "9630efe6-896d-4c04-bd77-ed7f0fcd4b11",
"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-26T21:10:47.1563206+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00"
},
"company_id": "ce7ea88e-1de3-4a62-b916-6ac837790da6",
"company_code": "sample string 12",
"db_address_id": "5cc7375f-70a4-46d4-92cf-dfa71b1ba9d5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "16aa6937-2e40-498f-9963-ea4420b96d0c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f5401199-1fc3-45b2-8953-770b77fce229",
"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-26T21:10:47.1563206+00:00",
"date_create": "2026-01-26T21:10:47.1563206+00:00",
"date_update": "2026-01-26T21:10:47.1563206+00:00",
"updated_by_user_id": "ba0aed28-6432-4d8c-ab14-c07af8a6cd0e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-26T21:10:47.1563206+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-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-26T21:10:47.1563206+00:00",
"date_last_job": "2026-01-26T21:10:47.1563206+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-26T21:10:47.1563206+00:00",
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00",
"is_mobile_installation": true
},
"job_type_id": "ec719357-d26a-4eab-b693-804bb5c0d0cb",
"job_type_code": "sample string 7",
"job_type": {
"id": "7b175ba3-3b2c-45eb-962e-5cd0dd62602b",
"name": "sample string 2",
"sales_organization_id": "69e70173-addb-4b37-a7ca-2eaef385a6b9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00",
"code": "sample string 7"
},
"job_priority_id": "d5e84704-d26e-4027-9b4c-3044fcbbecaf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f9d1c976-f41c-4c1c-9dc7-08f2f22e7d71",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "26f95ef1-1cb1-4484-a17e-06e562ef1c08",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f90bf511-bfcb-4599-892e-28339f3040b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e50f5d7f-8682-4381-b5d7-7f6098c2e2fb",
"db_currency_id": "c7ce082f-2ddf-48bb-b4b5-4f51c8d86149",
"db_language_id": "9630efe6-896d-4c04-bd77-ed7f0fcd4b11",
"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-26T21:10:47.1563206+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00"
},
"job_status_id": "c9011611-6fb6-498d-8d84-b1a07ecf66c0",
"job_status_code": "sample string 11",
"db_address_id": "12d1ca81-b036-4dac-ae4e-25c04eecfa12",
"contact_id": "19afd4bd-647b-4682-bd5f-e783e43d0afd",
"requested_by_company_id": "50d8c039-6d22-4f61-82f2-f4942fed971e",
"requested_by_contact_id": "1a9cc1f2-39c4-44f3-9415-2c77bb3dd44d",
"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-26T21:10:47.1563206+00:00",
"due_date": "2026-01-26T21:10:47.1563206+00:00",
"date_create": "2026-01-26T21:10:47.1563206+00:00",
"date_update": "2026-01-26T21:10:47.1563206+00:00",
"date_closed": "2026-01-26T21:10:47.1563206+00:00",
"suggested_user_id": "900c0b91-919b-4aa5-a101-9657bfdad293",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "24da274d-21af-45a0-98cb-8a3357ce9780",
"db_language_id": "c49232ac-f1b7-4887-b879-d5aefdd09a02",
"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-26T21:10:47.1563206+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1e735684-dab3-42be-9ebc-4c8e01a7e78b",
"sales_organization": {
"id": "f90bf511-bfcb-4599-892e-28339f3040b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e50f5d7f-8682-4381-b5d7-7f6098c2e2fb",
"db_currency_id": "c7ce082f-2ddf-48bb-b4b5-4f51c8d86149",
"db_language_id": "9630efe6-896d-4c04-bd77-ed7f0fcd4b11",
"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-26T21:10:47.1563206+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a31a5cf4-bcf3-4176-bbd1-162bb2e6fb3a",
"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": "392332e1-7406-4e6a-b550-afea1f629938",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ab6b8c9e-718e-42a0-afe8-0312f8267c6d"
},
"suggested_date_start": "2026-01-26T21:10:47.1563206+00:00",
"skill_id": "192ef6de-01f3-49a5-9aaa-e6ef3a4cfa6f",
"skill_code": "sample string 32",
"skill": {
"id": "ab3c1189-5425-415c-acf3-a373bad2531c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "538ed366-febf-444b-8206-2f04032f86d5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f90bf511-bfcb-4599-892e-28339f3040b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e50f5d7f-8682-4381-b5d7-7f6098c2e2fb",
"db_currency_id": "c7ce082f-2ddf-48bb-b4b5-4f51c8d86149",
"db_language_id": "9630efe6-896d-4c04-bd77-ed7f0fcd4b11",
"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-26T21:10:47.1563206+00:00"
},
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "070d84ce-f851-44b6-8347-85e074ccad55",
"date_reported_by_company": "2026-01-26T21:10:47.1563206+00:00",
"id2": 36,
"company_id": "a9e65b28-aaeb-4b27-93e3-5e712a9e5b5f",
"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": "80d853b4-7e40-4dc4-b797-0ba4a1898751",
"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-26T21:10:47.1563206+00:00"
},
"work_instruction_details_id": "edfc5315-e6c1-4b59-8ec6-351f09ae5859",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "381ba9f6-bc16-48e7-a8da-fe5a1b083572",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "37a2e393-d099-46e7-9216-8d774aff802e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-26T21:10:47.1563206+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": "4feab13d-7db9-460d-abd0-01cc1a42d763",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-26T21:10:47.1563206+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.