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": "6b61ec49-6e03-43d1-8ae0-231af610b129",
"jobs_id": "b0d6fae5-7ceb-45fc-8281-86152832e5a8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f4adc54e-0ac2-4732-ada4-39b2fed49c0e",
"_parent_id": "8772a015-3fad-4496-9efe-44b657a51b54",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "70da2596-0fa1-4c3f-a332-e2b92c364e4b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a0353efa-0a16-4dd1-a97b-839d7762fec0",
"_parent_id": "e64b6b74-00f2-41a6-89d0-6e798bb5dc05",
"root_parent_id": "a90d7ff0-1fa5-4b0a-9d1e-633b99e9dc5f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cd5a3b11-e452-4e91-bc15-c5370b97f970",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eaf585fd-9e7c-45d7-8e63-568fa8e0e48c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a059c088-e400-433f-8456-68c0a69387d8",
"_parent_code": "sample string 6",
"sales_organization_id": "5b7726f1-52b4-4287-b14d-53fe5ac14442",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "646b9213-532e-44f3-8e2a-7593db701bf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "631e860f-ea2e-4db0-9699-6613155d3e3d",
"db_currency_id": "64c549d8-198c-459c-af60-548507d68c4f",
"db_language_id": "7f545cd4-725d-40a4-95ba-44f000ec6daa",
"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-05-21T02:02:25.7629624+00:00"
},
"modified_dateutc": "2026-05-21T02:02:25.7629624+00:00"
},
"equipment_model_id": "c2d3bd9b-3218-4885-95be-8a6b7e1be1df",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4ad2684f-ae4a-41ee-b3c7-f6cdc83eb957",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "43e85263-0d44-47f6-9117-ad884904bf3a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fc3beba4-4078-4727-a60d-5f373062a3cf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ced0b713-3f75-4ce9-bb7a-acf6b10b9a1b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "646b9213-532e-44f3-8e2a-7593db701bf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "631e860f-ea2e-4db0-9699-6613155d3e3d",
"db_currency_id": "64c549d8-198c-459c-af60-548507d68c4f",
"db_language_id": "7f545cd4-725d-40a4-95ba-44f000ec6daa",
"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-05-21T02:02:25.7629624+00:00"
},
"modified_dateutc": "2026-05-21T02:02:25.7629624+00:00"
},
"equipment_family_id": "9aa937cc-2143-4bf5-93bb-a8bd26bffe97",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eaf585fd-9e7c-45d7-8e63-568fa8e0e48c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a059c088-e400-433f-8456-68c0a69387d8",
"_parent_code": "sample string 6",
"sales_organization_id": "5b7726f1-52b4-4287-b14d-53fe5ac14442",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "646b9213-532e-44f3-8e2a-7593db701bf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "631e860f-ea2e-4db0-9699-6613155d3e3d",
"db_currency_id": "64c549d8-198c-459c-af60-548507d68c4f",
"db_language_id": "7f545cd4-725d-40a4-95ba-44f000ec6daa",
"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-05-21T02:02:25.7629624+00:00"
},
"modified_dateutc": "2026-05-21T02:02:25.7629624+00:00"
},
"date_in_production_since": "2026-05-21T02:02:25.7629624+00:00",
"date_out_of_production_since": "2026-05-21T02:02:25.7629624+00:00",
"date_end_support": "2026-05-21T02:02:25.7629624+00:00",
"sales_organization_id": "c147d600-130f-472c-87ea-7a5fa213de33",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "646b9213-532e-44f3-8e2a-7593db701bf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "631e860f-ea2e-4db0-9699-6613155d3e3d",
"db_currency_id": "64c549d8-198c-459c-af60-548507d68c4f",
"db_language_id": "7f545cd4-725d-40a4-95ba-44f000ec6daa",
"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-05-21T02:02:25.7629624+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-05-21T02:02:25.7629624+00:00"
},
"project_status_id": "e07690dc-72a5-4ad7-9760-fe95f97b3db4",
"project_status_code": "sample string 10",
"project_status": {
"id": "f3af9016-727c-4167-9765-ffd92865e0f4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ad2a9640-dee1-4017-a70e-1dae8e7d4e89",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "646b9213-532e-44f3-8e2a-7593db701bf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "631e860f-ea2e-4db0-9699-6613155d3e3d",
"db_currency_id": "64c549d8-198c-459c-af60-548507d68c4f",
"db_language_id": "7f545cd4-725d-40a4-95ba-44f000ec6daa",
"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-05-21T02:02:25.7629624+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T02:02:25.7629624+00:00"
},
"company_id": "c5748be0-a36c-41d4-90e8-7d688f38987f",
"company_code": "sample string 12",
"db_address_id": "4924d1b4-ab45-43cf-8376-2229fe1e5bac",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "64bd3fc9-128a-455a-800e-b902d224ee8b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7efd62d4-acee-482e-b246-03417ef530c9",
"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-05-21T02:02:25.7629624+00:00",
"date_create": "2026-05-21T02:02:25.7629624+00:00",
"date_update": "2026-05-21T02:02:25.7629624+00:00",
"updated_by_user_id": "7627881d-a361-476b-bca5-d00c1849fd18",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-21T02:02:25.7629624+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-05-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-21T02:02:25.7629624+00:00",
"date_last_job": "2026-05-21T02:02:25.7629624+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-21T02:02:25.7629624+00:00",
"modified_dateutc": "2026-05-21T02:02:25.7629624+00:00",
"is_mobile_installation": true
},
"job_type_id": "975c3a70-08ba-448d-b1be-2efdc25d58b5",
"job_type_code": "sample string 7",
"job_type": {
"id": "75658259-3de7-4581-888e-da27543e0383",
"name": "sample string 2",
"sales_organization_id": "5dacc096-4377-4274-b00d-6e8019f47f03",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-21T02:02:25.7629624+00:00",
"code": "sample string 7"
},
"job_priority_id": "47fddff4-25b7-4039-9ebe-01e72e760dae",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b6b86426-0edb-43cf-acc7-d79b0e81f420",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d7570a04-1049-4396-98a6-36459b95894f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "646b9213-532e-44f3-8e2a-7593db701bf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "631e860f-ea2e-4db0-9699-6613155d3e3d",
"db_currency_id": "64c549d8-198c-459c-af60-548507d68c4f",
"db_language_id": "7f545cd4-725d-40a4-95ba-44f000ec6daa",
"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-05-21T02:02:25.7629624+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T02:02:25.7629624+00:00"
},
"job_status_id": "4cfee700-35b8-45ad-8bcd-6f9e46a6c511",
"job_status_code": "sample string 11",
"db_address_id": "53c25fef-abe6-4fe1-a9b8-fac4117625a8",
"contact_id": "37966a5a-bdcb-4f7c-8bb7-e71d15a313b4",
"requested_by_company_id": "45feca5b-f5b6-4732-b12b-92364c462344",
"requested_by_contact_id": "4c9ca9db-28cf-43f5-8b5c-c01f02e40cb0",
"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-05-21T02:02:25.7785841+00:00",
"due_date": "2026-05-21T02:02:25.7785841+00:00",
"date_create": "2026-05-21T02:02:25.7785841+00:00",
"date_update": "2026-05-21T02:02:25.7785841+00:00",
"date_closed": "2026-05-21T02:02:25.7785841+00:00",
"suggested_user_id": "af4873ad-c71c-4b92-80d0-7bc15778f4e1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3e946f55-b9ec-4a58-af07-1282be767dad",
"db_language_id": "bd86a8dc-d2e6-4a4e-9b43-954b029a2b4d",
"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-05-21T02:02:25.7785841+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "017794aa-ac6f-4ebf-b10b-cb1fe40bc114",
"sales_organization": {
"id": "646b9213-532e-44f3-8e2a-7593db701bf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "631e860f-ea2e-4db0-9699-6613155d3e3d",
"db_currency_id": "64c549d8-198c-459c-af60-548507d68c4f",
"db_language_id": "7f545cd4-725d-40a4-95ba-44f000ec6daa",
"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-05-21T02:02:25.7629624+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "52f7a84d-ef71-4159-9526-e28ccc53ec78",
"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": "f000b77a-630b-40fd-9091-d0061a45b129",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-21T02:02:25.7785841+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e5a97cfc-bdf4-4423-8981-19638e39c826"
},
"suggested_date_start": "2026-05-21T02:02:25.7785841+00:00",
"skill_id": "0d92e7e8-2b27-4b9d-acfe-0f3dfab1cf1b",
"skill_code": "sample string 32",
"skill": {
"id": "c5700721-9dcf-4980-81ae-7e5bd1c8fec9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "06d4e948-d138-4e0d-89b5-ae035d176dbc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "646b9213-532e-44f3-8e2a-7593db701bf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "631e860f-ea2e-4db0-9699-6613155d3e3d",
"db_currency_id": "64c549d8-198c-459c-af60-548507d68c4f",
"db_language_id": "7f545cd4-725d-40a4-95ba-44f000ec6daa",
"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-05-21T02:02:25.7629624+00:00"
},
"modified_dateutc": "2026-05-21T02:02:25.7785841+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "810fd441-9b7a-473a-b000-bed4c1ba946e",
"date_reported_by_company": "2026-05-21T02:02:25.7785841+00:00",
"id2": 36,
"company_id": "90a16172-3510-4b1f-95e1-6104e74aba59",
"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": "f055563d-81e0-4aa3-96be-6803faca7971",
"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-05-21T02:02:25.7785841+00:00"
},
"work_instruction_details_id": "90893be0-28a2-41ec-abbd-a94dd85496f4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e08a0f02-c268-4749-830e-5aa5487cbe45",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5f3e0939-1c9a-4f5c-9d52-f6076424db81",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-21T02:02:25.7785841+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": "00c9c95e-5247-429b-8421-b50480148785",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-21T02:02:25.7785841+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.