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": "39a3c992-3e14-42d7-bdb9-f50a1bd88307",
"jobs_id": "1addb809-80ae-4975-850e-145f2de40629",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "225dc382-f2e2-47f6-8bce-a93a495142c4",
"_parent_id": "ae8f9dfd-f58f-411d-8e6d-60e6dcd8fa64",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ae0d79bf-45a8-42c8-8787-832cceedefc2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "714724d8-b118-4c08-973b-e2d7cc29c833",
"_parent_id": "05cec851-94c2-4e06-a196-7cea51f84317",
"root_parent_id": "28224828-f448-4bba-875d-3f8249c86612",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "926a7781-30e6-466c-b82e-a10718e1290f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "686bf6ba-3bfb-4a8f-8c79-4d8996b2343a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e88bf604-1342-4749-920e-0523a7ba7615",
"_parent_code": "sample string 6",
"sales_organization_id": "122bd9ff-5abb-4f7f-a322-8c62278acfa2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3a4239f7-702a-4345-8052-0de145d1f01b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89922faf-c77a-4605-b484-ea5bf68437ea",
"db_currency_id": "91acd3ba-a60c-4362-b93e-426a0b902c65",
"db_language_id": "0c8e10aa-d5cd-49c2-a8f1-5b909a146988",
"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-03-06T23:33:41.6710058+00:00"
},
"modified_dateutc": "2026-03-06T23:33:41.6710058+00:00"
},
"equipment_model_id": "a58b4989-faa3-40d5-a50f-8312af2f73f5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6f590abe-d899-424b-a44d-7076e39de621",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ea54c045-0937-4dd7-8b3e-e3866155567a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ee9ffa1d-c9d1-4b05-a836-527b4416635a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3b6b7c69-3dc8-4383-800f-2b42670cbc72",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3a4239f7-702a-4345-8052-0de145d1f01b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89922faf-c77a-4605-b484-ea5bf68437ea",
"db_currency_id": "91acd3ba-a60c-4362-b93e-426a0b902c65",
"db_language_id": "0c8e10aa-d5cd-49c2-a8f1-5b909a146988",
"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-03-06T23:33:41.6710058+00:00"
},
"modified_dateutc": "2026-03-06T23:33:41.6710058+00:00"
},
"equipment_family_id": "76cfc314-a2aa-4ddf-bf8a-06b459fd71af",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "686bf6ba-3bfb-4a8f-8c79-4d8996b2343a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e88bf604-1342-4749-920e-0523a7ba7615",
"_parent_code": "sample string 6",
"sales_organization_id": "122bd9ff-5abb-4f7f-a322-8c62278acfa2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3a4239f7-702a-4345-8052-0de145d1f01b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89922faf-c77a-4605-b484-ea5bf68437ea",
"db_currency_id": "91acd3ba-a60c-4362-b93e-426a0b902c65",
"db_language_id": "0c8e10aa-d5cd-49c2-a8f1-5b909a146988",
"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-03-06T23:33:41.6710058+00:00"
},
"modified_dateutc": "2026-03-06T23:33:41.6710058+00:00"
},
"date_in_production_since": "2026-03-06T23:33:41.6710058+00:00",
"date_out_of_production_since": "2026-03-06T23:33:41.6710058+00:00",
"date_end_support": "2026-03-06T23:33:41.6710058+00:00",
"sales_organization_id": "8590dc4a-739f-4e26-8319-aecf2b4504a4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3a4239f7-702a-4345-8052-0de145d1f01b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89922faf-c77a-4605-b484-ea5bf68437ea",
"db_currency_id": "91acd3ba-a60c-4362-b93e-426a0b902c65",
"db_language_id": "0c8e10aa-d5cd-49c2-a8f1-5b909a146988",
"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-03-06T23:33:41.6710058+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-03-06T23:33:41.6710058+00:00"
},
"project_status_id": "b812d2c3-7882-4219-8f80-439a5fccd567",
"project_status_code": "sample string 10",
"project_status": {
"id": "26e3418d-700d-4ef3-a1ce-1713c96b107a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "12524f5e-4801-4062-8ad4-440d8f29f4b5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a4239f7-702a-4345-8052-0de145d1f01b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89922faf-c77a-4605-b484-ea5bf68437ea",
"db_currency_id": "91acd3ba-a60c-4362-b93e-426a0b902c65",
"db_language_id": "0c8e10aa-d5cd-49c2-a8f1-5b909a146988",
"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-03-06T23:33:41.6710058+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-06T23:33:41.6710058+00:00"
},
"company_id": "05692298-308a-46b6-854f-f14e3497261e",
"company_code": "sample string 12",
"db_address_id": "f0df06dc-d861-4955-a320-01c5588a8f93",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5a2d3f62-f60d-4804-82c6-0fea183e8eea",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bf72a94a-6783-4a1b-9837-e05e1e7e40b4",
"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-03-06T23:33:41.6710058+00:00",
"date_create": "2026-03-06T23:33:41.6710058+00:00",
"date_update": "2026-03-06T23:33:41.6866286+00:00",
"updated_by_user_id": "297e26aa-4c5f-43de-b866-84a1e1b52e37",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-06T23:33:41.6866286+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-03-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-06T23:33:41.6866286+00:00",
"date_last_job": "2026-03-06T23:33:41.6866286+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-06T23:33:41.6866286+00:00",
"modified_dateutc": "2026-03-06T23:33:41.6866286+00:00",
"is_mobile_installation": true
},
"job_type_id": "09ddd783-250e-4363-98ae-016b51701b26",
"job_type_code": "sample string 7",
"job_type": {
"id": "6820af6d-f14c-436d-8288-fc9f43c3177c",
"name": "sample string 2",
"sales_organization_id": "3703b703-617c-45ff-be71-3a0584d50835",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-06T23:33:41.6866286+00:00",
"code": "sample string 7"
},
"job_priority_id": "d1a4e002-cc7d-4415-a930-69e56a8ad3b9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c419a4b3-96a0-40f5-a968-5b4bf9e8266a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "83040811-8862-4063-bbf9-7b855a1184cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a4239f7-702a-4345-8052-0de145d1f01b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89922faf-c77a-4605-b484-ea5bf68437ea",
"db_currency_id": "91acd3ba-a60c-4362-b93e-426a0b902c65",
"db_language_id": "0c8e10aa-d5cd-49c2-a8f1-5b909a146988",
"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-03-06T23:33:41.6710058+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-06T23:33:41.6866286+00:00"
},
"job_status_id": "f80423b1-e19e-4b38-a17d-6094dc7a3a7a",
"job_status_code": "sample string 11",
"db_address_id": "d486011a-3c7d-4354-8834-8a323800d2e3",
"contact_id": "3b5e6ab4-2cd3-4259-8117-01c5b05e51e8",
"requested_by_company_id": "9d64b984-0e4a-47e8-afb3-96feac021e56",
"requested_by_contact_id": "efdbafb9-88b7-45e4-ac72-21d7295d2cb6",
"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-03-06T23:33:41.6866286+00:00",
"due_date": "2026-03-06T23:33:41.6866286+00:00",
"date_create": "2026-03-06T23:33:41.6866286+00:00",
"date_update": "2026-03-06T23:33:41.6866286+00:00",
"date_closed": "2026-03-06T23:33:41.6866286+00:00",
"suggested_user_id": "df51bd47-c66a-4e79-8923-b7bd3fe327d5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "635bf8bc-a16f-4c61-9a71-e62cd94f5c1e",
"db_language_id": "ebe3029f-1ba1-4395-83ce-7759ee4a1736",
"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-03-06T23:33:41.6866286+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1fb05116-3eed-4f2c-87d0-3c8c42a059a4",
"sales_organization": {
"id": "3a4239f7-702a-4345-8052-0de145d1f01b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89922faf-c77a-4605-b484-ea5bf68437ea",
"db_currency_id": "91acd3ba-a60c-4362-b93e-426a0b902c65",
"db_language_id": "0c8e10aa-d5cd-49c2-a8f1-5b909a146988",
"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-03-06T23:33:41.6710058+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2308760f-5947-4aee-a572-53f5b26a5aa5",
"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": "db73f9d4-5cea-4ae6-b021-86009eeb7b3b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-06T23:33:41.6866286+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "84139096-3557-451f-88ec-f9b8f21eaabb"
},
"suggested_date_start": "2026-03-06T23:33:41.6866286+00:00",
"skill_id": "26ea2b88-37aa-4672-a9d4-6043abcb7132",
"skill_code": "sample string 32",
"skill": {
"id": "4447c340-387b-4fef-8d59-d07ef9556ed1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c3b28aae-87c0-4b8d-ae60-27b2ae971bca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a4239f7-702a-4345-8052-0de145d1f01b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89922faf-c77a-4605-b484-ea5bf68437ea",
"db_currency_id": "91acd3ba-a60c-4362-b93e-426a0b902c65",
"db_language_id": "0c8e10aa-d5cd-49c2-a8f1-5b909a146988",
"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-03-06T23:33:41.6710058+00:00"
},
"modified_dateutc": "2026-03-06T23:33:41.6866286+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7f46e85b-d87c-4afc-83af-2e7f78583d2b",
"date_reported_by_company": "2026-03-06T23:33:41.6866286+00:00",
"id2": 36,
"company_id": "68fca5a7-1855-422d-a931-415bf7fa750f",
"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": "ca690c9d-3e30-4f91-96df-8f4f399d7cbc",
"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-03-06T23:33:41.6866286+00:00"
},
"work_instruction_details_id": "30909a36-394f-4a8d-bf98-a7ce66214533",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "edf2e995-356c-47c7-8fc1-28f2c17fd130",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "229746ed-d039-4ffa-bca7-2c516e85328f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-06T23:33:41.6866286+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": "b21fa39d-58bd-4378-8087-1851bef84b8d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-06T23:33:41.6866286+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.