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": "daa58d9f-6b8e-4b03-83fa-3b2c6ad2f4a0",
"jobs_id": "ebd91be3-9b9f-4a2f-976b-020f0c7e232d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c205edef-07a3-4822-a778-b436832a2334",
"_parent_id": "92ff87e2-2de1-418c-b1df-31a2e4270ca7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f983c46a-dc48-48da-b787-12b13d04921c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cec1d9b8-84b2-443e-addb-f1fbc3f55819",
"_parent_id": "75e390d4-a134-463e-91d1-eca36c61794b",
"root_parent_id": "3d5fe889-f29a-49bc-bd13-c158f56e0c3b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3c23ebc3-a86b-4d2f-b243-5b63accaa78e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "555aa7b5-bc04-4614-be47-80a062edeb18",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e35d9113-96c9-4560-925d-f7e8e8f94811",
"_parent_code": "sample string 6",
"sales_organization_id": "fa84b2f4-ca89-4683-b131-535e2e48d623",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "49b01ecc-af7f-4f7c-bf0c-449618e75e51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b447d2df-309d-48da-9bfd-5643abf150f3",
"db_currency_id": "71df7857-dc66-43d3-8d2f-2223f3600795",
"db_language_id": "1a7d6224-d0f9-4b8f-abb8-b4fd0a3408cc",
"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-06-09T07:18:29.6361873+00:00"
},
"modified_dateutc": "2026-06-09T07:18:29.6361873+00:00"
},
"equipment_model_id": "98926143-5796-4372-ab80-ecc23010432f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0fe4819c-4ea1-4d9f-a7e2-2f09ca9d05ec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "872ec1e4-2bbb-4609-a4fc-011e571a1c9d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "86eb40ba-4280-46d6-a868-940de03a19c2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3cade74b-3290-44a3-a310-6ca2270ee897",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "49b01ecc-af7f-4f7c-bf0c-449618e75e51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b447d2df-309d-48da-9bfd-5643abf150f3",
"db_currency_id": "71df7857-dc66-43d3-8d2f-2223f3600795",
"db_language_id": "1a7d6224-d0f9-4b8f-abb8-b4fd0a3408cc",
"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-06-09T07:18:29.6361873+00:00"
},
"modified_dateutc": "2026-06-09T07:18:29.6518113+00:00"
},
"equipment_family_id": "dddeb74c-36bb-4581-9d05-e1cfbead74da",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "555aa7b5-bc04-4614-be47-80a062edeb18",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e35d9113-96c9-4560-925d-f7e8e8f94811",
"_parent_code": "sample string 6",
"sales_organization_id": "fa84b2f4-ca89-4683-b131-535e2e48d623",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "49b01ecc-af7f-4f7c-bf0c-449618e75e51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b447d2df-309d-48da-9bfd-5643abf150f3",
"db_currency_id": "71df7857-dc66-43d3-8d2f-2223f3600795",
"db_language_id": "1a7d6224-d0f9-4b8f-abb8-b4fd0a3408cc",
"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-06-09T07:18:29.6361873+00:00"
},
"modified_dateutc": "2026-06-09T07:18:29.6361873+00:00"
},
"date_in_production_since": "2026-06-09T07:18:29.6518113+00:00",
"date_out_of_production_since": "2026-06-09T07:18:29.6518113+00:00",
"date_end_support": "2026-06-09T07:18:29.6518113+00:00",
"sales_organization_id": "151153b6-b757-459f-9ec0-c7e029e46db7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "49b01ecc-af7f-4f7c-bf0c-449618e75e51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b447d2df-309d-48da-9bfd-5643abf150f3",
"db_currency_id": "71df7857-dc66-43d3-8d2f-2223f3600795",
"db_language_id": "1a7d6224-d0f9-4b8f-abb8-b4fd0a3408cc",
"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-06-09T07:18:29.6361873+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-06-09T07:18:29.6518113+00:00"
},
"project_status_id": "b4841e72-62b9-42fc-aea5-55dbb299498b",
"project_status_code": "sample string 10",
"project_status": {
"id": "272af445-76a9-4b5c-ae82-583125d48516",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "adfe9f55-c410-428d-89dc-9b1f5fbf1507",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "49b01ecc-af7f-4f7c-bf0c-449618e75e51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b447d2df-309d-48da-9bfd-5643abf150f3",
"db_currency_id": "71df7857-dc66-43d3-8d2f-2223f3600795",
"db_language_id": "1a7d6224-d0f9-4b8f-abb8-b4fd0a3408cc",
"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-06-09T07:18:29.6361873+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T07:18:29.6518113+00:00"
},
"company_id": "226bbb8e-9633-4258-acaf-a7387ab802ec",
"company_code": "sample string 12",
"db_address_id": "03a8e102-4de1-4b20-8760-5f5b8e01d03a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "701e7e9c-86e6-4f8c-aca1-097ce1cb62cb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "25b0a998-3eb3-46f2-8e40-e08e013d1b44",
"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-06-09T07:18:29.6518113+00:00",
"date_create": "2026-06-09T07:18:29.6518113+00:00",
"date_update": "2026-06-09T07:18:29.6518113+00:00",
"updated_by_user_id": "9b86140e-246c-4398-8689-1ac6511e06e8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-09T07:18:29.6518113+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-06-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-09T07:18:29.6518113+00:00",
"date_last_job": "2026-06-09T07:18:29.6518113+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-09T07:18:29.6518113+00:00",
"modified_dateutc": "2026-06-09T07:18:29.6518113+00:00",
"is_mobile_installation": true
},
"job_type_id": "cae3268c-f223-4568-9300-8956e7eae23b",
"job_type_code": "sample string 7",
"job_type": {
"id": "83f9c617-3c11-44c3-bf3a-341d2af12530",
"name": "sample string 2",
"sales_organization_id": "84d6ec8b-70f3-4c96-85f8-1c6f3b809c42",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-09T07:18:29.6518113+00:00",
"code": "sample string 7"
},
"job_priority_id": "6b31ac01-1a53-4a19-91cd-891e58030f94",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a38dffb7-a156-4e40-9289-e51333caddff",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fb7ad316-8608-4700-82c4-84ffc6376286",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "49b01ecc-af7f-4f7c-bf0c-449618e75e51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b447d2df-309d-48da-9bfd-5643abf150f3",
"db_currency_id": "71df7857-dc66-43d3-8d2f-2223f3600795",
"db_language_id": "1a7d6224-d0f9-4b8f-abb8-b4fd0a3408cc",
"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-06-09T07:18:29.6361873+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T07:18:29.6518113+00:00"
},
"job_status_id": "e9f67d40-a68f-4fe8-a9a6-d889472907c6",
"job_status_code": "sample string 11",
"db_address_id": "bf191ec2-6df2-487e-adaa-71fbdae9741e",
"contact_id": "c473896e-832a-435b-abb3-25bff6232539",
"requested_by_company_id": "d7be1379-6035-471b-8180-8d8d4b721dab",
"requested_by_contact_id": "ba290ed8-659b-4c65-9c52-923cd0b232fe",
"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-06-09T07:18:29.6518113+00:00",
"due_date": "2026-06-09T07:18:29.6518113+00:00",
"date_create": "2026-06-09T07:18:29.6518113+00:00",
"date_update": "2026-06-09T07:18:29.6518113+00:00",
"date_closed": "2026-06-09T07:18:29.6518113+00:00",
"suggested_user_id": "a01cee7b-e357-40f4-a2a9-3781bf6f0f1e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "28ec75fc-9d3a-451e-a2b2-444edbc285b1",
"db_language_id": "a1fc72cd-8a58-4c7e-b47a-91c5b15157d0",
"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-06-09T07:18:29.6518113+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a3de57f6-16aa-4a5a-8276-612d5ecc63b7",
"sales_organization": {
"id": "49b01ecc-af7f-4f7c-bf0c-449618e75e51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b447d2df-309d-48da-9bfd-5643abf150f3",
"db_currency_id": "71df7857-dc66-43d3-8d2f-2223f3600795",
"db_language_id": "1a7d6224-d0f9-4b8f-abb8-b4fd0a3408cc",
"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-06-09T07:18:29.6361873+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "043f47a2-04fb-47b0-9683-e0093279461a",
"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": "4adcc618-05c0-4297-966c-bb630f18e09a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-09T07:18:29.6518113+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1fbcc9b8-67fb-4d0b-a921-32ceeecb1b1d"
},
"suggested_date_start": "2026-06-09T07:18:29.6518113+00:00",
"skill_id": "dba8376d-4695-48aa-91be-27cea27a6557",
"skill_code": "sample string 32",
"skill": {
"id": "ca72b4cd-fb7a-4dd1-addc-3bca5c7e00a6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d80063f1-17b8-4de9-a630-ef7935e1acb9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "49b01ecc-af7f-4f7c-bf0c-449618e75e51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b447d2df-309d-48da-9bfd-5643abf150f3",
"db_currency_id": "71df7857-dc66-43d3-8d2f-2223f3600795",
"db_language_id": "1a7d6224-d0f9-4b8f-abb8-b4fd0a3408cc",
"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-06-09T07:18:29.6361873+00:00"
},
"modified_dateutc": "2026-06-09T07:18:29.6518113+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "031a271c-b23a-468b-893a-f140c6eb57e2",
"date_reported_by_company": "2026-06-09T07:18:29.6518113+00:00",
"id2": 36,
"company_id": "65fc8d19-5214-450a-b6a9-78cf8ccf2ba8",
"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": "c8f85fd2-4f24-4153-ba0f-4da859262fd1",
"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-06-09T07:18:29.6518113+00:00"
},
"work_instruction_details_id": "cb1abd3b-7cc8-4c96-af7a-c0943a2377c1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ed7200a8-237a-4010-ae6d-7d13c1948232",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "500ae522-034b-49ca-adc6-901ed9bcba02",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-09T07:18:29.6518113+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": "60eab750-0a01-4653-b4f8-8a7841d56d56",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-09T07:18:29.6518113+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.