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": "2fd80765-6ae1-4aa4-aeee-bb356670fa29",
"jobs_id": "4119c3c6-35e4-45d5-9e24-22ce42f8adea",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e456f905-9ed2-4b3b-a137-2fcb1237463e",
"_parent_id": "d72dc03b-9b51-4d3c-ac8c-5656e2090255",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dff635ba-8bf2-4e74-b1fe-7c44e89b7715",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a3eb9185-a618-41be-a349-c893dea7ebb3",
"_parent_id": "d27e7291-67bf-4f39-ae5c-38deab2d5eb5",
"root_parent_id": "2cbee074-219a-4a6a-953a-d101c9dcafd7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ec3fcd53-02c9-4881-a91d-bd3ad699fb0d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2d7cdd5e-3f1d-482a-89bd-548a385e518b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4a08be53-e209-4a15-898b-4c20afa4c584",
"_parent_code": "sample string 6",
"sales_organization_id": "74fc510f-7514-42e9-889a-7797565e0114",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "22a2583d-bffd-424b-83de-fc6e8f7b2ffe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78e91ab-16b7-4d87-93dd-72b78536fb02",
"db_currency_id": "962a2ea9-f3e2-4da5-96c0-b782b163c3db",
"db_language_id": "ebbb846e-9c4d-4c5c-9e9b-da95f412ebfc",
"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-07T14:37:36.1595447+00:00"
},
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00"
},
"equipment_model_id": "d72265e2-52e8-49a4-b822-49d5bf25982b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4a465529-4705-451e-800c-96a02f9c1ab6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "83645da4-cbaf-422a-9615-6ef823c572b7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f4ec1a1c-a444-4fdc-aec6-0be7ce7e14b0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4f02f5d2-258b-4632-ac5f-125ec84dcbc5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "22a2583d-bffd-424b-83de-fc6e8f7b2ffe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78e91ab-16b7-4d87-93dd-72b78536fb02",
"db_currency_id": "962a2ea9-f3e2-4da5-96c0-b782b163c3db",
"db_language_id": "ebbb846e-9c4d-4c5c-9e9b-da95f412ebfc",
"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-07T14:37:36.1595447+00:00"
},
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00"
},
"equipment_family_id": "9fe30ee8-3e49-4fd8-a0d8-31b4cc7e3a42",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2d7cdd5e-3f1d-482a-89bd-548a385e518b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4a08be53-e209-4a15-898b-4c20afa4c584",
"_parent_code": "sample string 6",
"sales_organization_id": "74fc510f-7514-42e9-889a-7797565e0114",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "22a2583d-bffd-424b-83de-fc6e8f7b2ffe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78e91ab-16b7-4d87-93dd-72b78536fb02",
"db_currency_id": "962a2ea9-f3e2-4da5-96c0-b782b163c3db",
"db_language_id": "ebbb846e-9c4d-4c5c-9e9b-da95f412ebfc",
"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-07T14:37:36.1595447+00:00"
},
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00"
},
"date_in_production_since": "2026-07-07T14:37:36.1595447+00:00",
"date_out_of_production_since": "2026-07-07T14:37:36.1595447+00:00",
"date_end_support": "2026-07-07T14:37:36.1595447+00:00",
"sales_organization_id": "5213b711-92bb-4933-8079-725bc63494c6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "22a2583d-bffd-424b-83de-fc6e8f7b2ffe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78e91ab-16b7-4d87-93dd-72b78536fb02",
"db_currency_id": "962a2ea9-f3e2-4da5-96c0-b782b163c3db",
"db_language_id": "ebbb846e-9c4d-4c5c-9e9b-da95f412ebfc",
"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-07T14:37:36.1595447+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-07T14:37:36.1595447+00:00"
},
"project_status_id": "0eca6ad2-2e3a-4750-98ab-cf75332c10df",
"project_status_code": "sample string 10",
"project_status": {
"id": "6e0b84fa-a03e-4058-b587-9ac38f563959",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f95c80bc-295b-4c55-abf0-1f4207398a7f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "22a2583d-bffd-424b-83de-fc6e8f7b2ffe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78e91ab-16b7-4d87-93dd-72b78536fb02",
"db_currency_id": "962a2ea9-f3e2-4da5-96c0-b782b163c3db",
"db_language_id": "ebbb846e-9c4d-4c5c-9e9b-da95f412ebfc",
"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-07T14:37:36.1595447+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00"
},
"company_id": "d6d712c7-2dfa-4858-9693-bc3949c6518c",
"company_code": "sample string 12",
"db_address_id": "b957098a-fd0b-4023-9809-29428cfe6309",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2f61df13-ea0f-4f72-9a12-19d645209e6b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e1b5b337-2639-4af0-90de-f295db70d4f7",
"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-07T14:37:36.1595447+00:00",
"date_create": "2026-07-07T14:37:36.1595447+00:00",
"date_update": "2026-07-07T14:37:36.1595447+00:00",
"updated_by_user_id": "5e952367-1dee-47c6-a852-7bedbf54e769",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-07T14:37:36.1595447+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-07T14:37:36.1595447+00:00",
"date_last_job": "2026-07-07T14:37:36.1595447+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-07T14:37:36.1595447+00:00",
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00",
"is_mobile_installation": true
},
"job_type_id": "9ec72cd4-287f-4919-912a-c8239384a069",
"job_type_code": "sample string 7",
"job_type": {
"id": "bd1b68f8-3b76-4b60-9118-64aa1f192f6c",
"name": "sample string 2",
"sales_organization_id": "7dbf5c61-50eb-46cd-9b52-d43411819694",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00",
"code": "sample string 7"
},
"job_priority_id": "825609c8-9b69-4666-8aec-a56131030187",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d1c15ae7-f4c3-4f1b-ba48-75ac2998a4c3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ee6d050d-821a-48eb-91fd-25c808281d3f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "22a2583d-bffd-424b-83de-fc6e8f7b2ffe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78e91ab-16b7-4d87-93dd-72b78536fb02",
"db_currency_id": "962a2ea9-f3e2-4da5-96c0-b782b163c3db",
"db_language_id": "ebbb846e-9c4d-4c5c-9e9b-da95f412ebfc",
"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-07T14:37:36.1595447+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00"
},
"job_status_id": "112c5210-5fb5-4269-ad12-f77e0c8360d8",
"job_status_code": "sample string 11",
"db_address_id": "5b33287b-91ba-4b58-9f29-0abfdf3432b0",
"contact_id": "e4dab2db-1cc3-4c45-9a10-7da720801b7d",
"requested_by_company_id": "5b5470e3-9234-4710-a8cf-c60b9589934f",
"requested_by_contact_id": "669a55f1-6675-49c4-8b76-a32d49d74189",
"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-07T14:37:36.1595447+00:00",
"due_date": "2026-07-07T14:37:36.1595447+00:00",
"date_create": "2026-07-07T14:37:36.1595447+00:00",
"date_update": "2026-07-07T14:37:36.1595447+00:00",
"date_closed": "2026-07-07T14:37:36.1595447+00:00",
"suggested_user_id": "927a01bd-41af-4f76-9fe3-62ca10700832",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "26df6c71-a047-449f-bda6-2ab9c2ac2db3",
"db_language_id": "81cd2171-9e9c-4245-bc06-f831c597b3b3",
"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-07T14:37:36.1595447+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3f0c935d-7053-45f4-b0e0-9f8c05bc7e3d",
"sales_organization": {
"id": "22a2583d-bffd-424b-83de-fc6e8f7b2ffe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78e91ab-16b7-4d87-93dd-72b78536fb02",
"db_currency_id": "962a2ea9-f3e2-4da5-96c0-b782b163c3db",
"db_language_id": "ebbb846e-9c4d-4c5c-9e9b-da95f412ebfc",
"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-07T14:37:36.1595447+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d051b4f5-b4b3-4f1f-8241-65f6ee756e75",
"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": "33fc6dcf-b3b1-4543-81b6-0b0438f821c7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f7a7ba83-978e-4e62-afb1-7d277e6aace0"
},
"suggested_date_start": "2026-07-07T14:37:36.1595447+00:00",
"skill_id": "0380a11a-7c9f-4d3f-8d48-90d9662edbee",
"skill_code": "sample string 32",
"skill": {
"id": "28ec01ae-bb9f-4635-8a82-eb9b2a3150a5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b1664aff-9b71-43d2-b080-86af4a283836",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "22a2583d-bffd-424b-83de-fc6e8f7b2ffe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78e91ab-16b7-4d87-93dd-72b78536fb02",
"db_currency_id": "962a2ea9-f3e2-4da5-96c0-b782b163c3db",
"db_language_id": "ebbb846e-9c4d-4c5c-9e9b-da95f412ebfc",
"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-07T14:37:36.1595447+00:00"
},
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "944de227-1ec8-405c-b23e-f9817865f26b",
"date_reported_by_company": "2026-07-07T14:37:36.1595447+00:00",
"id2": 36,
"company_id": "da8cf6d4-eb91-42b1-b091-ebb90a0b4b32",
"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": "c8dbb120-934f-4007-a8fa-550556d1b652",
"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-07T14:37:36.1595447+00:00"
},
"work_instruction_details_id": "bc250102-3f63-486c-b773-b870c0a957cd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6a757695-9f84-485d-be2a-0a0101280758",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c5aa9753-6c7a-4d13-b20d-2b7ea429bfbc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-07T14:37:36.1595447+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": "fd34bfae-5ca6-4c15-bc03-85e7380b5981",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-07T14:37:36.1595447+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.