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": "94ea2473-c6f1-4dfd-853e-ca75b1ee220e",
"jobs_id": "39ba1498-f9de-403b-b460-ce95214aa934",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "024ecd30-fdbf-40e0-a5c7-86df425025bb",
"_parent_id": "690eddf2-5706-4438-b22f-9a912ef6f5df",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9d04a83e-a64e-41c9-8ba0-60626215ca9c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "77cfc951-8fcc-43b6-9f19-1834e9345f1d",
"_parent_id": "f99efe48-6a72-4529-9725-4e0b381f2fa0",
"root_parent_id": "c1367fb0-1f41-4be6-be74-48beb3b31aa9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cd3c2921-6948-4c87-be25-948fc43a1a58",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a11304a7-d41b-408e-b069-c1cd109691bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cc135fcf-3c4a-4bd8-aed7-b19deb10bb56",
"_parent_code": "sample string 6",
"sales_organization_id": "3125b459-b897-4447-950c-9413233e6220",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f29348b1-90c6-41c3-aa3d-c76ae33f53ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ed46916-66fa-4bf4-8794-7ded1f8c3908",
"db_currency_id": "654f0a55-5780-4ba5-a7a7-e533eaa6eee5",
"db_language_id": "12a2ca7f-9cf8-4b6c-9af7-01fb0d1a2945",
"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-04-04T04:58:06.6420888+00:00"
},
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00"
},
"equipment_model_id": "dc8a0a85-4f8c-4a16-ad33-24a8e3c23bba",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7105ce44-4551-4a9f-a2e6-2ad146d726ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0107666d-ebed-4f4c-b16c-8d0900d91f33",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ac426b81-c2c7-4b38-8372-fa52b94958a2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "91662016-192c-4ec7-8d47-148abee21f8a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f29348b1-90c6-41c3-aa3d-c76ae33f53ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ed46916-66fa-4bf4-8794-7ded1f8c3908",
"db_currency_id": "654f0a55-5780-4ba5-a7a7-e533eaa6eee5",
"db_language_id": "12a2ca7f-9cf8-4b6c-9af7-01fb0d1a2945",
"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-04-04T04:58:06.6420888+00:00"
},
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00"
},
"equipment_family_id": "0fc7f984-4e6b-43a5-bc93-0f63fa655eff",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a11304a7-d41b-408e-b069-c1cd109691bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cc135fcf-3c4a-4bd8-aed7-b19deb10bb56",
"_parent_code": "sample string 6",
"sales_organization_id": "3125b459-b897-4447-950c-9413233e6220",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f29348b1-90c6-41c3-aa3d-c76ae33f53ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ed46916-66fa-4bf4-8794-7ded1f8c3908",
"db_currency_id": "654f0a55-5780-4ba5-a7a7-e533eaa6eee5",
"db_language_id": "12a2ca7f-9cf8-4b6c-9af7-01fb0d1a2945",
"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-04-04T04:58:06.6420888+00:00"
},
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00"
},
"date_in_production_since": "2026-04-04T04:58:06.6420888+00:00",
"date_out_of_production_since": "2026-04-04T04:58:06.6420888+00:00",
"date_end_support": "2026-04-04T04:58:06.6420888+00:00",
"sales_organization_id": "0b0fb1dd-4b05-4ed7-9a8b-b146acb24cab",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f29348b1-90c6-41c3-aa3d-c76ae33f53ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ed46916-66fa-4bf4-8794-7ded1f8c3908",
"db_currency_id": "654f0a55-5780-4ba5-a7a7-e533eaa6eee5",
"db_language_id": "12a2ca7f-9cf8-4b6c-9af7-01fb0d1a2945",
"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-04-04T04:58:06.6420888+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-04-04T04:58:06.6420888+00:00"
},
"project_status_id": "8eb27801-44a2-4738-8bbf-fc3fe2f0e963",
"project_status_code": "sample string 10",
"project_status": {
"id": "c1360247-c941-4597-a43a-4df790c41739",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e0fecb17-a250-41d4-bad2-8b2f70fc99ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f29348b1-90c6-41c3-aa3d-c76ae33f53ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ed46916-66fa-4bf4-8794-7ded1f8c3908",
"db_currency_id": "654f0a55-5780-4ba5-a7a7-e533eaa6eee5",
"db_language_id": "12a2ca7f-9cf8-4b6c-9af7-01fb0d1a2945",
"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-04-04T04:58:06.6420888+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00"
},
"company_id": "0a47f005-8c73-45c7-b9cd-1343f596ef7d",
"company_code": "sample string 12",
"db_address_id": "ad18d0cd-9c35-4f77-ae9e-be5fbb780eed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c46509fb-5f5a-45be-aefe-5b1d2e2dcb93",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0d17047f-286c-4a32-8aed-67172f8e9308",
"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-04-04T04:58:06.6420888+00:00",
"date_create": "2026-04-04T04:58:06.6420888+00:00",
"date_update": "2026-04-04T04:58:06.6420888+00:00",
"updated_by_user_id": "4cf48053-fafc-4ba6-bd7c-3dd60ea35833",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-04T04:58:06.6420888+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-04-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-04T04:58:06.6420888+00:00",
"date_last_job": "2026-04-04T04:58:06.6420888+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-04T04:58:06.6420888+00:00",
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00",
"is_mobile_installation": true
},
"job_type_id": "4f04b9b1-9b3f-411c-867a-397caf9b87df",
"job_type_code": "sample string 7",
"job_type": {
"id": "da8e07bf-fb30-4720-af08-e386ed7ddfc0",
"name": "sample string 2",
"sales_organization_id": "3408514e-28e1-4de5-8c16-4766d37799d3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00",
"code": "sample string 7"
},
"job_priority_id": "2b6dee48-27cf-4753-9d8c-0bb5fe5f5b38",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4a340a63-e572-4447-8405-be5b83bbd16e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3e3fc022-ade4-40f2-a877-80f3cedd1574",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f29348b1-90c6-41c3-aa3d-c76ae33f53ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ed46916-66fa-4bf4-8794-7ded1f8c3908",
"db_currency_id": "654f0a55-5780-4ba5-a7a7-e533eaa6eee5",
"db_language_id": "12a2ca7f-9cf8-4b6c-9af7-01fb0d1a2945",
"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-04-04T04:58:06.6420888+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00"
},
"job_status_id": "1b4fde5d-a649-4edf-819c-2d4557e1842e",
"job_status_code": "sample string 11",
"db_address_id": "d0be7b07-7147-483a-af0c-6dd5c2eabdf5",
"contact_id": "03e7187a-f583-4022-b258-9c80385d9ddd",
"requested_by_company_id": "e1480b4c-183e-41c5-aad8-5d14ab72bc1f",
"requested_by_contact_id": "c80d1581-7cf2-41ab-9258-6068da185294",
"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-04-04T04:58:06.6420888+00:00",
"due_date": "2026-04-04T04:58:06.6420888+00:00",
"date_create": "2026-04-04T04:58:06.6420888+00:00",
"date_update": "2026-04-04T04:58:06.6420888+00:00",
"date_closed": "2026-04-04T04:58:06.6420888+00:00",
"suggested_user_id": "64e4eff2-4886-424a-a33a-08c33bce3651",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7355414a-3d9e-4f83-b112-580d44c1f41c",
"db_language_id": "fcbbff50-0d13-41e7-ae6b-eb1f68c26f3d",
"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-04-04T04:58:06.6420888+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b6dab3a1-25eb-429a-9acd-ea793708d655",
"sales_organization": {
"id": "f29348b1-90c6-41c3-aa3d-c76ae33f53ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ed46916-66fa-4bf4-8794-7ded1f8c3908",
"db_currency_id": "654f0a55-5780-4ba5-a7a7-e533eaa6eee5",
"db_language_id": "12a2ca7f-9cf8-4b6c-9af7-01fb0d1a2945",
"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-04-04T04:58:06.6420888+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d871019d-d0f0-437e-9dd1-e500555fe859",
"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": "100567a3-239c-4325-8305-f827dce85902",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b743b7ab-681a-4f64-abdf-6ebf90cdc9d4"
},
"suggested_date_start": "2026-04-04T04:58:06.6420888+00:00",
"skill_id": "8d54fdf5-78e0-4af3-b820-6f9ed47e2a42",
"skill_code": "sample string 32",
"skill": {
"id": "4712e910-4ef3-440a-a6d3-2f7d7eb66f6a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8ef90373-da75-4b2c-92f5-5d3f28853878",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f29348b1-90c6-41c3-aa3d-c76ae33f53ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ed46916-66fa-4bf4-8794-7ded1f8c3908",
"db_currency_id": "654f0a55-5780-4ba5-a7a7-e533eaa6eee5",
"db_language_id": "12a2ca7f-9cf8-4b6c-9af7-01fb0d1a2945",
"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-04-04T04:58:06.6420888+00:00"
},
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "683560c0-09c5-4693-bddd-8a1e1680cbf2",
"date_reported_by_company": "2026-04-04T04:58:06.6420888+00:00",
"id2": 36,
"company_id": "028f58df-19c8-4731-ab8d-f280bd50149c",
"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": "d30af9a9-83e2-4034-af75-17f1b78d512f",
"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-04-04T04:58:06.6420888+00:00"
},
"work_instruction_details_id": "9d55c551-2afe-40f5-aef2-a4d98b75c82f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dcfa552e-32df-423a-9fdb-a2828e47747d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "506bdfcd-73fe-4d01-ba42-8a8b64842d99",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-04T04:58:06.6420888+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": "2a87e65c-d6c1-4db9-8f0a-d96fad9d2c84",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-04T04:58:06.6420888+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.