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": "90d9a816-8349-47bc-b90a-2a04bbf721c3",
"jobs_id": "0fab4973-3641-4a88-b070-ac0083347814",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9cc691c4-10d5-4616-b0c5-a8b7ec95be57",
"_parent_id": "0eca92dc-7976-40e5-bf2a-2f2225605835",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c514ec25-372f-40d7-8448-d2670a34d705",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7e02e74c-c07c-45ae-8439-a62efc6da4a6",
"_parent_id": "182b528c-ec54-4856-b05e-d314032c82de",
"root_parent_id": "9cd3fba5-424f-4502-a393-30c22fd637aa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "937c8b07-627f-4aab-8dcf-cb4fffdcd8bc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "847f9aed-a329-406f-8a6a-ba2e3b718f9a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8f690cf9-f61a-4dc5-952a-533024ceb99c",
"_parent_code": "sample string 6",
"sales_organization_id": "0241d0a8-81be-4a1d-b9bc-e78f6142f64e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "64fa8aed-2835-4564-99e0-4a057823f00a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d579c0f0-446d-405c-980d-8d2ab7938c24",
"db_currency_id": "cbb3e3bb-eefb-4d15-aba2-b18926db72e8",
"db_language_id": "ef6cbca3-3dab-4803-8d9f-eab9a4f93d9c",
"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-09T03:33:34.5980628+00:00"
},
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00"
},
"equipment_model_id": "50b7bfce-f8e7-4b56-9d6e-a03e5ce4fb14",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fc17b723-6e9b-4fd5-a749-5be36b845259",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fe603e7b-0f10-47c7-a6c4-29950a59e83b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f8945fa3-e497-4aa7-9a50-3bd1f04a651b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fa04fa14-af47-4ec7-88c7-1e11af568e1c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "64fa8aed-2835-4564-99e0-4a057823f00a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d579c0f0-446d-405c-980d-8d2ab7938c24",
"db_currency_id": "cbb3e3bb-eefb-4d15-aba2-b18926db72e8",
"db_language_id": "ef6cbca3-3dab-4803-8d9f-eab9a4f93d9c",
"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-09T03:33:34.5980628+00:00"
},
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00"
},
"equipment_family_id": "c9eb7c82-5e90-461f-8d2c-0d60d2d77ee1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "847f9aed-a329-406f-8a6a-ba2e3b718f9a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8f690cf9-f61a-4dc5-952a-533024ceb99c",
"_parent_code": "sample string 6",
"sales_organization_id": "0241d0a8-81be-4a1d-b9bc-e78f6142f64e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "64fa8aed-2835-4564-99e0-4a057823f00a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d579c0f0-446d-405c-980d-8d2ab7938c24",
"db_currency_id": "cbb3e3bb-eefb-4d15-aba2-b18926db72e8",
"db_language_id": "ef6cbca3-3dab-4803-8d9f-eab9a4f93d9c",
"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-09T03:33:34.5980628+00:00"
},
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00"
},
"date_in_production_since": "2026-07-09T03:33:34.5980628+00:00",
"date_out_of_production_since": "2026-07-09T03:33:34.5980628+00:00",
"date_end_support": "2026-07-09T03:33:34.5980628+00:00",
"sales_organization_id": "2b8779b4-1aca-4970-8777-7b1c87df9be2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "64fa8aed-2835-4564-99e0-4a057823f00a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d579c0f0-446d-405c-980d-8d2ab7938c24",
"db_currency_id": "cbb3e3bb-eefb-4d15-aba2-b18926db72e8",
"db_language_id": "ef6cbca3-3dab-4803-8d9f-eab9a4f93d9c",
"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-09T03:33:34.5980628+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-09T03:33:34.5980628+00:00"
},
"project_status_id": "50296718-d8c0-4525-8880-7f565c302d7d",
"project_status_code": "sample string 10",
"project_status": {
"id": "ab060e6f-0ae4-4257-b5ef-21bb631f7518",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7c67acec-79c1-42a3-872b-10418f336fbb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64fa8aed-2835-4564-99e0-4a057823f00a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d579c0f0-446d-405c-980d-8d2ab7938c24",
"db_currency_id": "cbb3e3bb-eefb-4d15-aba2-b18926db72e8",
"db_language_id": "ef6cbca3-3dab-4803-8d9f-eab9a4f93d9c",
"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-09T03:33:34.5980628+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00"
},
"company_id": "c38e7f43-b597-43aa-ad7d-48e99891f509",
"company_code": "sample string 12",
"db_address_id": "1a3a1847-1018-4733-9749-6ca72b6e5606",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eb5e53e7-f4c2-4347-bd8c-1335d414a5f1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "499e5be7-10e2-4171-a638-9c42c04ace9d",
"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-09T03:33:34.5980628+00:00",
"date_create": "2026-07-09T03:33:34.5980628+00:00",
"date_update": "2026-07-09T03:33:34.5980628+00:00",
"updated_by_user_id": "d7669a18-2d21-4e27-80d0-ac4f9d3dce1e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-09T03:33:34.5980628+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-09T03:33:34.5980628+00:00",
"date_last_job": "2026-07-09T03:33:34.5980628+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-09T03:33:34.5980628+00:00",
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00",
"is_mobile_installation": true
},
"job_type_id": "e62d18f4-b57e-4cca-aa45-19a055e3b2b5",
"job_type_code": "sample string 7",
"job_type": {
"id": "93182add-0079-4dc9-865c-b4466b164ed0",
"name": "sample string 2",
"sales_organization_id": "f3b393fc-1c96-4f76-9814-d2b7f532d825",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00",
"code": "sample string 7"
},
"job_priority_id": "06d0eb30-fb0b-47b7-99a3-96e95317a195",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "de3a9b16-30a3-4dc5-9708-0f75c6469770",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6eb88014-21c8-4d24-ba3a-78d405253125",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64fa8aed-2835-4564-99e0-4a057823f00a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d579c0f0-446d-405c-980d-8d2ab7938c24",
"db_currency_id": "cbb3e3bb-eefb-4d15-aba2-b18926db72e8",
"db_language_id": "ef6cbca3-3dab-4803-8d9f-eab9a4f93d9c",
"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-09T03:33:34.5980628+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00"
},
"job_status_id": "02a49154-b2f1-48a0-8908-6be77821bcbe",
"job_status_code": "sample string 11",
"db_address_id": "74c68c0c-27bf-4e5f-baea-e65900b86835",
"contact_id": "d9d5e774-7a9e-460f-a21b-3aeb62ab5f43",
"requested_by_company_id": "8e97d2d6-50ff-4ac4-9c7c-148bd93c373f",
"requested_by_contact_id": "6f1d3652-a449-4525-adfd-1947ccc075ef",
"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-09T03:33:34.5980628+00:00",
"due_date": "2026-07-09T03:33:34.5980628+00:00",
"date_create": "2026-07-09T03:33:34.5980628+00:00",
"date_update": "2026-07-09T03:33:34.5980628+00:00",
"date_closed": "2026-07-09T03:33:34.5980628+00:00",
"suggested_user_id": "e5c559cc-6f4a-4d6e-bbe3-8c58ea1a8aad",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "135cfacd-f8f4-4989-8e66-f08e49ca5f5c",
"db_language_id": "510dfb01-b60a-4bce-8d5f-5adb9fd423ce",
"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-09T03:33:34.5980628+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "51e5ce0b-839f-4eed-b8a1-0266856aed9d",
"sales_organization": {
"id": "64fa8aed-2835-4564-99e0-4a057823f00a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d579c0f0-446d-405c-980d-8d2ab7938c24",
"db_currency_id": "cbb3e3bb-eefb-4d15-aba2-b18926db72e8",
"db_language_id": "ef6cbca3-3dab-4803-8d9f-eab9a4f93d9c",
"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-09T03:33:34.5980628+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "73e36424-508e-4b1b-aeab-3aee44cde69b",
"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": "0e85d74a-8fb1-44ce-911c-6b884cd707eb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "036a33d2-2ae1-406b-9802-c4453fae028f"
},
"suggested_date_start": "2026-07-09T03:33:34.5980628+00:00",
"skill_id": "1c8d70f8-addd-46ac-9e34-396649e785c0",
"skill_code": "sample string 32",
"skill": {
"id": "65cb6001-b1b7-40db-8d78-1912f191ab96",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "283af063-8b67-421e-af74-31e57d7d6802",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64fa8aed-2835-4564-99e0-4a057823f00a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d579c0f0-446d-405c-980d-8d2ab7938c24",
"db_currency_id": "cbb3e3bb-eefb-4d15-aba2-b18926db72e8",
"db_language_id": "ef6cbca3-3dab-4803-8d9f-eab9a4f93d9c",
"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-09T03:33:34.5980628+00:00"
},
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "329300cf-0b61-4047-b7ae-0340f84e71c0",
"date_reported_by_company": "2026-07-09T03:33:34.5980628+00:00",
"id2": 36,
"company_id": "26f8b808-25aa-4ffe-98e8-61809998968d",
"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": "bc662249-67f9-41b7-ade0-a9fcb0d9a9cf",
"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-09T03:33:34.5980628+00:00"
},
"work_instruction_details_id": "71a2cf6b-73f1-4980-8361-591591c10550",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9fde44a8-a110-4bc5-b70d-41763df5b2c7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1df38767-1e78-4bba-b510-e3ce694cd695",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-09T03:33:34.5980628+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": "4da8553d-38a7-44ae-89b6-77e252bb3214",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-09T03:33:34.5980628+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.