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": "0aa7da61-0045-41f9-a006-3c85282a83d3",
"jobs_id": "a09b14fa-dc37-4ccd-bf8c-d71e1b280818",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "20dbaa7b-8483-4359-98ae-d4570cb7082a",
"_parent_id": "8891496c-9c36-417a-9c86-2e5762ba2cae",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f50dac86-c16b-4b77-8e05-0e0891751c75",
"project_reference_back_office": "sample string 5",
"project": {
"id": "52b4c60a-4b80-44ac-ad79-e0e897d100a3",
"_parent_id": "26ce2f36-de0c-4391-a9c8-24aaae170d86",
"root_parent_id": "75d18624-5cef-47c9-9c65-dbf04751fbc9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5704d06c-739f-4023-abeb-7d138172d845",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "18941c02-7b54-4041-b7e2-0c1908ab77a1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "514c63f1-93d7-4024-8d99-2e171330feab",
"_parent_code": "sample string 6",
"sales_organization_id": "f60985ae-932b-42e6-8ebe-19b5f00c68ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f01973ea-ca21-42bf-afa4-4d853d94b765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "751ff0f3-41f9-45aa-a782-187ac9bb7689",
"db_currency_id": "335e6520-d9be-4fb0-abe7-76e36382607f",
"db_language_id": "4c3355cd-b5f9-4d6c-9854-63325c1280c5",
"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-23T00:33:28.2321071+00:00"
},
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00"
},
"equipment_model_id": "c9863027-ac11-4241-b3d9-5a8f0d9be636",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "589d9abc-2fdd-4fec-8a99-e93ba9bfcbbc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "51d42add-fa84-4164-b2f2-6f4fc6cf4bc6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "63e83237-6834-4ed6-bda6-5ade51ddd71c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "09ef961f-dbbf-4184-859b-2701564d3c77",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f01973ea-ca21-42bf-afa4-4d853d94b765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "751ff0f3-41f9-45aa-a782-187ac9bb7689",
"db_currency_id": "335e6520-d9be-4fb0-abe7-76e36382607f",
"db_language_id": "4c3355cd-b5f9-4d6c-9854-63325c1280c5",
"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-23T00:33:28.2321071+00:00"
},
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00"
},
"equipment_family_id": "ae29f589-23e9-4b68-b65e-b260263233a5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "18941c02-7b54-4041-b7e2-0c1908ab77a1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "514c63f1-93d7-4024-8d99-2e171330feab",
"_parent_code": "sample string 6",
"sales_organization_id": "f60985ae-932b-42e6-8ebe-19b5f00c68ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f01973ea-ca21-42bf-afa4-4d853d94b765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "751ff0f3-41f9-45aa-a782-187ac9bb7689",
"db_currency_id": "335e6520-d9be-4fb0-abe7-76e36382607f",
"db_language_id": "4c3355cd-b5f9-4d6c-9854-63325c1280c5",
"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-23T00:33:28.2321071+00:00"
},
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00"
},
"date_in_production_since": "2026-07-23T00:33:28.2321071+00:00",
"date_out_of_production_since": "2026-07-23T00:33:28.2321071+00:00",
"date_end_support": "2026-07-23T00:33:28.2321071+00:00",
"sales_organization_id": "d5956ac5-4e6c-476d-9203-46455a3d2251",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f01973ea-ca21-42bf-afa4-4d853d94b765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "751ff0f3-41f9-45aa-a782-187ac9bb7689",
"db_currency_id": "335e6520-d9be-4fb0-abe7-76e36382607f",
"db_language_id": "4c3355cd-b5f9-4d6c-9854-63325c1280c5",
"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-23T00:33:28.2321071+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-23T00:33:28.2321071+00:00"
},
"project_status_id": "6a01fa12-dca7-471d-aa98-8dc3b485ce59",
"project_status_code": "sample string 10",
"project_status": {
"id": "fc0e6fed-1369-4c56-948b-ef37039f78a1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "98e03db8-5961-472f-9bf4-cc7ec9690948",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f01973ea-ca21-42bf-afa4-4d853d94b765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "751ff0f3-41f9-45aa-a782-187ac9bb7689",
"db_currency_id": "335e6520-d9be-4fb0-abe7-76e36382607f",
"db_language_id": "4c3355cd-b5f9-4d6c-9854-63325c1280c5",
"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-23T00:33:28.2321071+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00"
},
"company_id": "d8f08f2b-d4b5-4d9a-bcb3-8969284f990c",
"company_code": "sample string 12",
"db_address_id": "1e6657d5-076e-4a92-aad6-e77b764834d3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "03ee6d87-6ccd-4b02-8816-b51dd033549f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b3e9a233-89dc-4f3f-b15c-e75d76a2b970",
"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-23T00:33:28.2321071+00:00",
"date_create": "2026-07-23T00:33:28.2321071+00:00",
"date_update": "2026-07-23T00:33:28.2321071+00:00",
"updated_by_user_id": "74b205bc-64f0-48dc-be22-40a5635eeca7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-23T00:33:28.2321071+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-23T00:33:28.2321071+00:00",
"date_last_job": "2026-07-23T00:33:28.2321071+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-23T00:33:28.2321071+00:00",
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00",
"is_mobile_installation": true
},
"job_type_id": "ad65d97e-9a72-48f6-823f-555cc4604dbc",
"job_type_code": "sample string 7",
"job_type": {
"id": "6e559853-f119-4b0f-bafd-5a2d51ddafba",
"name": "sample string 2",
"sales_organization_id": "1a725384-531e-4ce6-9265-562633a7be43",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00",
"code": "sample string 7"
},
"job_priority_id": "a2703019-708a-4145-85b0-42d1c6359df1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6b0b80f2-7ace-4444-ba45-3d307950ee7a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "847d57ac-bd0b-4c10-9874-8581ed9ed60e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f01973ea-ca21-42bf-afa4-4d853d94b765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "751ff0f3-41f9-45aa-a782-187ac9bb7689",
"db_currency_id": "335e6520-d9be-4fb0-abe7-76e36382607f",
"db_language_id": "4c3355cd-b5f9-4d6c-9854-63325c1280c5",
"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-23T00:33:28.2321071+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00"
},
"job_status_id": "11f85916-7485-4be3-a6f0-66d203f9c8fd",
"job_status_code": "sample string 11",
"db_address_id": "1326cd69-8617-46bd-b71f-702af71c297f",
"contact_id": "e34b50be-cff7-4a93-95e1-6ac377449f06",
"requested_by_company_id": "1a95bfb6-3440-4b7d-8c6f-27b622d85ade",
"requested_by_contact_id": "066242cf-8b44-40e1-ace0-d9e9c9493a04",
"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-23T00:33:28.2321071+00:00",
"due_date": "2026-07-23T00:33:28.2321071+00:00",
"date_create": "2026-07-23T00:33:28.2321071+00:00",
"date_update": "2026-07-23T00:33:28.2321071+00:00",
"date_closed": "2026-07-23T00:33:28.2321071+00:00",
"suggested_user_id": "70393f94-e68f-41f5-8716-3fe5892fb3de",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e95ba44e-7529-4657-90c0-528dfc23ad4d",
"db_language_id": "a8dc747d-3b46-4666-999d-249b518e9972",
"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-23T00:33:28.2321071+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "db9b2863-2c54-4389-98a6-68c48cd6e2e0",
"sales_organization": {
"id": "f01973ea-ca21-42bf-afa4-4d853d94b765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "751ff0f3-41f9-45aa-a782-187ac9bb7689",
"db_currency_id": "335e6520-d9be-4fb0-abe7-76e36382607f",
"db_language_id": "4c3355cd-b5f9-4d6c-9854-63325c1280c5",
"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-23T00:33:28.2321071+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "94eeb378-e1ca-46cc-b7fa-032778fd08bb",
"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": "1a141724-9c43-4b4a-9c0c-7e2a9a4c674e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b60a4331-6ea6-487d-9602-239bab4785a2"
},
"suggested_date_start": "2026-07-23T00:33:28.2321071+00:00",
"skill_id": "e9843124-c71f-43fb-9759-6cc3f0c47025",
"skill_code": "sample string 32",
"skill": {
"id": "010e382e-f83a-4774-90c4-efbc371f7777",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "14e82cae-bf79-42d6-bf0b-18b70ee268d7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f01973ea-ca21-42bf-afa4-4d853d94b765",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "751ff0f3-41f9-45aa-a782-187ac9bb7689",
"db_currency_id": "335e6520-d9be-4fb0-abe7-76e36382607f",
"db_language_id": "4c3355cd-b5f9-4d6c-9854-63325c1280c5",
"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-23T00:33:28.2321071+00:00"
},
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b23e7abc-5bf7-465e-820b-f2eb65431033",
"date_reported_by_company": "2026-07-23T00:33:28.2321071+00:00",
"id2": 36,
"company_id": "795bd913-454f-44e7-b647-072632604b1f",
"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": "8968a8a9-4707-4e0a-a4bc-83332d30be44",
"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-23T00:33:28.2321071+00:00"
},
"work_instruction_details_id": "be26a057-98cb-409c-aea2-acfab8b55015",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8c17a626-9c8c-464b-8197-e047c91ca585",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "856f6d17-1760-41fe-91d4-bed64d2f7d8b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-23T00:33:28.2321071+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": "7bd66d9d-d4c9-47e8-9151-2132db114b1e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-23T00:33:28.2321071+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.