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": "98e90474-40bf-4f29-97c7-36bdf9dbe67f",
"jobs_id": "820d9e8c-5dd9-4fc2-9de3-327283ea1fd7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5c09252f-ad14-4eda-bb96-76a1d8c22bfc",
"_parent_id": "e365b6c9-b945-4ec4-bbc0-3307f5cadc51",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "576116a7-ca43-4714-bc75-6b84bf6fd958",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cc61734c-0e39-42bd-a614-3ba892a723b9",
"_parent_id": "66d9c8a2-5205-44a6-9b60-cd1625a1ae03",
"root_parent_id": "8ba0a42c-0240-4c3a-ba51-c9175fd2b9ff",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5d16ed38-5c71-4a20-a1fd-6a00c19999f7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fc424497-9a18-424e-a004-568d9d3aec46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "40b8d66b-6f27-4882-a433-32033ba623ca",
"_parent_code": "sample string 6",
"sales_organization_id": "4313fdd8-58bb-43be-8ab8-acc6e17795ed",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b96fc8d4-3e68-4a93-a568-e505977a2cfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f49ca6bb-3758-49de-b35c-377f69dac5ae",
"db_currency_id": "c64d7ed0-7a8d-4ef5-a9b6-16dc499f157d",
"db_language_id": "f7a8b3b1-9b7f-47d1-a79c-efe6004a9233",
"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-30T16:40:15.2536926+00:00"
},
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00"
},
"equipment_model_id": "d0f916b5-5378-4b0a-88ee-b31f74e2d4a9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3e86629f-c456-4d6e-b28b-bfc22052ca19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f54c5f52-5c6e-476b-8858-f4d405e21490",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "50d041a9-f27f-4706-8fc3-fd669d6c7d04",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "21214a80-6721-4127-98fa-2f1c7fa9e426",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b96fc8d4-3e68-4a93-a568-e505977a2cfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f49ca6bb-3758-49de-b35c-377f69dac5ae",
"db_currency_id": "c64d7ed0-7a8d-4ef5-a9b6-16dc499f157d",
"db_language_id": "f7a8b3b1-9b7f-47d1-a79c-efe6004a9233",
"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-30T16:40:15.2536926+00:00"
},
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00"
},
"equipment_family_id": "cdf77e2e-9028-4ed9-8853-92fbc8984c8f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fc424497-9a18-424e-a004-568d9d3aec46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "40b8d66b-6f27-4882-a433-32033ba623ca",
"_parent_code": "sample string 6",
"sales_organization_id": "4313fdd8-58bb-43be-8ab8-acc6e17795ed",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b96fc8d4-3e68-4a93-a568-e505977a2cfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f49ca6bb-3758-49de-b35c-377f69dac5ae",
"db_currency_id": "c64d7ed0-7a8d-4ef5-a9b6-16dc499f157d",
"db_language_id": "f7a8b3b1-9b7f-47d1-a79c-efe6004a9233",
"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-30T16:40:15.2536926+00:00"
},
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00"
},
"date_in_production_since": "2026-06-30T16:40:15.2536926+00:00",
"date_out_of_production_since": "2026-06-30T16:40:15.2536926+00:00",
"date_end_support": "2026-06-30T16:40:15.2536926+00:00",
"sales_organization_id": "3d03f764-59b0-41a8-9e9b-b6fc249daa90",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b96fc8d4-3e68-4a93-a568-e505977a2cfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f49ca6bb-3758-49de-b35c-377f69dac5ae",
"db_currency_id": "c64d7ed0-7a8d-4ef5-a9b6-16dc499f157d",
"db_language_id": "f7a8b3b1-9b7f-47d1-a79c-efe6004a9233",
"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-30T16:40:15.2536926+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-30T16:40:15.2536926+00:00"
},
"project_status_id": "b822a7aa-cbcd-46bb-99f9-50670ad34e9b",
"project_status_code": "sample string 10",
"project_status": {
"id": "02bcb4c9-41f3-4fd0-800c-be082098e729",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d0e79d93-bbf0-4667-8579-03640cd26c1d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b96fc8d4-3e68-4a93-a568-e505977a2cfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f49ca6bb-3758-49de-b35c-377f69dac5ae",
"db_currency_id": "c64d7ed0-7a8d-4ef5-a9b6-16dc499f157d",
"db_language_id": "f7a8b3b1-9b7f-47d1-a79c-efe6004a9233",
"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-30T16:40:15.2536926+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00"
},
"company_id": "e68624b3-a568-46a6-bd97-bd51f05a82ee",
"company_code": "sample string 12",
"db_address_id": "fa0fce14-e831-402b-9a94-ed69d68037c5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e5a6df55-834a-430a-92a4-4643a0646e84",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4c233640-0dc2-4aeb-aca0-50fe7863e254",
"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-30T16:40:15.2536926+00:00",
"date_create": "2026-06-30T16:40:15.2536926+00:00",
"date_update": "2026-06-30T16:40:15.2536926+00:00",
"updated_by_user_id": "d791e5ae-b145-401f-ae45-e8ec06423b49",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-30T16:40:15.2536926+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-30T16:40:15.2536926+00:00",
"date_last_job": "2026-06-30T16:40:15.2536926+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-30T16:40:15.2536926+00:00",
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00",
"is_mobile_installation": true
},
"job_type_id": "06fdacd3-f6ff-4e40-b9b2-5ba0967a287e",
"job_type_code": "sample string 7",
"job_type": {
"id": "2d0d2d35-963d-4cdf-9e19-c3c40a22eb39",
"name": "sample string 2",
"sales_organization_id": "5f0fd8d0-9e45-40ad-b778-2d337b8d20eb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00",
"code": "sample string 7"
},
"job_priority_id": "0181562f-e59e-4f87-8088-1706768cc863",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "be5e6c13-811a-4a37-8eee-85b34206fd4f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "daab6d2d-7803-427b-81ad-7a8c982da5f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b96fc8d4-3e68-4a93-a568-e505977a2cfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f49ca6bb-3758-49de-b35c-377f69dac5ae",
"db_currency_id": "c64d7ed0-7a8d-4ef5-a9b6-16dc499f157d",
"db_language_id": "f7a8b3b1-9b7f-47d1-a79c-efe6004a9233",
"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-30T16:40:15.2536926+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00"
},
"job_status_id": "8d2e839b-9ba5-41a2-bdb6-9c1c2c7883ee",
"job_status_code": "sample string 11",
"db_address_id": "03b05e56-aaf1-4e2c-939b-6f2d21a25716",
"contact_id": "12c50c73-4a41-4ccd-b7ea-31781db615df",
"requested_by_company_id": "01f6fc42-c244-4c7c-9971-d3baba43474d",
"requested_by_contact_id": "131b8c39-59ba-40b8-b07a-70fb927e3f6b",
"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-30T16:40:15.2536926+00:00",
"due_date": "2026-06-30T16:40:15.2536926+00:00",
"date_create": "2026-06-30T16:40:15.2536926+00:00",
"date_update": "2026-06-30T16:40:15.2536926+00:00",
"date_closed": "2026-06-30T16:40:15.2536926+00:00",
"suggested_user_id": "932f6d06-69e0-4d43-bea1-d6d1760d5394",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "80ab55fa-2a69-45ab-a6bf-859e9020c51d",
"db_language_id": "ed20d02a-9f91-419b-9f10-532201cfc75b",
"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-30T16:40:15.2536926+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fa2a42be-6576-4db5-986a-8d8b695c697d",
"sales_organization": {
"id": "b96fc8d4-3e68-4a93-a568-e505977a2cfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f49ca6bb-3758-49de-b35c-377f69dac5ae",
"db_currency_id": "c64d7ed0-7a8d-4ef5-a9b6-16dc499f157d",
"db_language_id": "f7a8b3b1-9b7f-47d1-a79c-efe6004a9233",
"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-30T16:40:15.2536926+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7959cfe7-2120-4603-a298-3da0a890e001",
"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": "7b5101f7-0dee-4cb1-a924-9b1f5eed5c9b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1a31add4-b8ab-4c3a-bc7f-b473b94f4dfc"
},
"suggested_date_start": "2026-06-30T16:40:15.2536926+00:00",
"skill_id": "ce5d1356-5067-4632-bdcf-9680b93ea027",
"skill_code": "sample string 32",
"skill": {
"id": "9bd924b9-7746-44d4-b2fa-17737f7655f9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "97dfb158-ef2b-491d-9034-b12b930513fb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b96fc8d4-3e68-4a93-a568-e505977a2cfe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f49ca6bb-3758-49de-b35c-377f69dac5ae",
"db_currency_id": "c64d7ed0-7a8d-4ef5-a9b6-16dc499f157d",
"db_language_id": "f7a8b3b1-9b7f-47d1-a79c-efe6004a9233",
"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-30T16:40:15.2536926+00:00"
},
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "900f2b05-09f9-4066-bd70-923287b3559a",
"date_reported_by_company": "2026-06-30T16:40:15.2536926+00:00",
"id2": 36,
"company_id": "691fe671-1811-40e8-a011-77991bd269d8",
"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": "ada1efa9-2840-47a8-8eb3-5d8e4594fc51",
"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-30T16:40:15.2536926+00:00"
},
"work_instruction_details_id": "495e6937-da33-4886-ac96-7712db183a98",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "68e7978a-28d5-45c3-a066-f55b6afc22d3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ea85f7f9-eba4-4ec9-b751-cd689690ad19",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-30T16:40:15.2536926+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": "6657bd06-20df-4be4-8006-0cd1cef7fccf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-30T16:40:15.2536926+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.