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": "dad9b4c5-f6e7-4850-b18c-ed1661a75bbb",
"jobs_id": "52e163b4-ab41-4848-b88d-9b178693e6fa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6b0cabc5-edda-427e-b78a-38386022e90b",
"_parent_id": "3b472f8b-1647-4272-a540-2597c1a1b6a4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cf726222-821d-4e9e-b2ad-6ff55a34c0d8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6f39af79-701e-4ba1-a4cf-20dde3d5ced2",
"_parent_id": "ee860fe2-72e9-47de-b784-f4820a6fbd8b",
"root_parent_id": "ab5247fc-0703-43e5-b9e8-80e4187dc28b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "862fb24e-3ab1-4cba-a4cc-21cb4937310c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "83ffdd3b-b717-4de3-96c4-e9fc6d2ed116",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b441c9e9-36cc-4db0-8c64-e31e49571cb6",
"_parent_code": "sample string 6",
"sales_organization_id": "10a1d42d-967b-4ad0-9c13-e761fea8aaf3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "05bd6be7-c4e8-4e8e-8c5e-33fb564e1718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41195652-ee1f-49b0-96fc-cbad9d7f6fb2",
"db_currency_id": "f86533a8-a4ed-4c87-a5d5-5c15a5982da2",
"db_language_id": "e3a3162e-35c1-428e-8af7-42802b757856",
"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-09-19T12:17:19.5259377+00:00"
},
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00"
},
"equipment_model_id": "17bfece0-96d5-42f0-86d2-c3533f3c9963",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5cf58691-3367-4a4c-a1f2-9214b2045794",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bba79a40-f490-4fe4-9643-92417f1fd98e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2ada20ed-76f9-47ce-8905-93247fa26677",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "93b9efef-b0cc-4bf9-bb7e-a81a928dd539",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "05bd6be7-c4e8-4e8e-8c5e-33fb564e1718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41195652-ee1f-49b0-96fc-cbad9d7f6fb2",
"db_currency_id": "f86533a8-a4ed-4c87-a5d5-5c15a5982da2",
"db_language_id": "e3a3162e-35c1-428e-8af7-42802b757856",
"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-09-19T12:17:19.5259377+00:00"
},
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00"
},
"equipment_family_id": "38d7ac1e-2bc4-4e28-9421-443eb3bdd322",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "83ffdd3b-b717-4de3-96c4-e9fc6d2ed116",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b441c9e9-36cc-4db0-8c64-e31e49571cb6",
"_parent_code": "sample string 6",
"sales_organization_id": "10a1d42d-967b-4ad0-9c13-e761fea8aaf3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "05bd6be7-c4e8-4e8e-8c5e-33fb564e1718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41195652-ee1f-49b0-96fc-cbad9d7f6fb2",
"db_currency_id": "f86533a8-a4ed-4c87-a5d5-5c15a5982da2",
"db_language_id": "e3a3162e-35c1-428e-8af7-42802b757856",
"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-09-19T12:17:19.5259377+00:00"
},
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00"
},
"date_in_production_since": "2026-09-19T12:17:19.5259377+00:00",
"date_out_of_production_since": "2026-09-19T12:17:19.5259377+00:00",
"date_end_support": "2026-09-19T12:17:19.5259377+00:00",
"sales_organization_id": "0512f1b1-296e-47a4-a12f-687373a7d425",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "05bd6be7-c4e8-4e8e-8c5e-33fb564e1718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41195652-ee1f-49b0-96fc-cbad9d7f6fb2",
"db_currency_id": "f86533a8-a4ed-4c87-a5d5-5c15a5982da2",
"db_language_id": "e3a3162e-35c1-428e-8af7-42802b757856",
"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-09-19T12:17:19.5259377+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-09-19T12:17:19.5259377+00:00"
},
"project_status_id": "03d0e4f4-7740-42df-b032-3f8a0237d2c7",
"project_status_code": "sample string 10",
"project_status": {
"id": "0fcca1b2-0df6-4d45-a006-1fdb2a781c72",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4cdc10b9-0324-48aa-8f15-d8555e3c32dc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "05bd6be7-c4e8-4e8e-8c5e-33fb564e1718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41195652-ee1f-49b0-96fc-cbad9d7f6fb2",
"db_currency_id": "f86533a8-a4ed-4c87-a5d5-5c15a5982da2",
"db_language_id": "e3a3162e-35c1-428e-8af7-42802b757856",
"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-09-19T12:17:19.5259377+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00"
},
"company_id": "d415aef7-4db1-406b-8188-94855065a913",
"company_code": "sample string 12",
"db_address_id": "1f4d8d13-dc8f-4fc0-a538-0eebb7de8de2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "050f05cd-e5de-45aa-a609-578330b05540",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e3825886-0b13-4a63-93e0-8cc97a546cc2",
"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-09-19T12:17:19.5259377+00:00",
"date_create": "2026-09-19T12:17:19.5259377+00:00",
"date_update": "2026-09-19T12:17:19.5259377+00:00",
"updated_by_user_id": "2b8783ed-c195-41f4-a43e-4622ea3cf1c9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-19T12:17:19.5259377+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-09-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-19T12:17:19.5259377+00:00",
"date_last_job": "2026-09-19T12:17:19.5259377+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-19T12:17:19.5259377+00:00",
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00",
"is_mobile_installation": true
},
"job_type_id": "5160c099-1520-440d-8ecc-14ea7190326a",
"job_type_code": "sample string 7",
"job_type": {
"id": "a2a53e27-b3a7-442f-a3a7-3d0470adf774",
"name": "sample string 2",
"sales_organization_id": "fe18b1d7-7875-4425-9e4b-8f941542c62a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00",
"code": "sample string 7"
},
"job_priority_id": "629ae3fd-848f-4c1d-9515-f3ac03e6e797",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "82f916fa-37ea-4d9d-b761-0aced1ac6a44",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b72ba085-255b-4201-9651-f484d896e275",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "05bd6be7-c4e8-4e8e-8c5e-33fb564e1718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41195652-ee1f-49b0-96fc-cbad9d7f6fb2",
"db_currency_id": "f86533a8-a4ed-4c87-a5d5-5c15a5982da2",
"db_language_id": "e3a3162e-35c1-428e-8af7-42802b757856",
"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-09-19T12:17:19.5259377+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00"
},
"job_status_id": "f3d05029-e8ba-43ab-873a-47dd4de0adc1",
"job_status_code": "sample string 11",
"db_address_id": "da11a001-c787-4663-836d-2e9d86341130",
"contact_id": "7e172b5a-a32f-495f-9dda-0efdc5931253",
"requested_by_company_id": "ce50d306-4959-41bd-9fc8-cf3df7e9f99a",
"requested_by_contact_id": "30a1373a-7d14-4146-abed-f41b1f6ff94c",
"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-09-19T12:17:19.5259377+00:00",
"due_date": "2026-09-19T12:17:19.5259377+00:00",
"date_create": "2026-09-19T12:17:19.5259377+00:00",
"date_update": "2026-09-19T12:17:19.5259377+00:00",
"date_closed": "2026-09-19T12:17:19.5259377+00:00",
"suggested_user_id": "edd500e9-4395-49aa-9b2b-7a8df8d95e16",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "08557dd9-d661-4b79-ace6-e24430df30aa",
"db_language_id": "6b84d009-ff49-4c15-acd0-c427ddbbec67",
"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-09-19T12:17:19.5259377+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "65c74152-42d0-4e7c-b07a-8bce14497315",
"sales_organization": {
"id": "05bd6be7-c4e8-4e8e-8c5e-33fb564e1718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41195652-ee1f-49b0-96fc-cbad9d7f6fb2",
"db_currency_id": "f86533a8-a4ed-4c87-a5d5-5c15a5982da2",
"db_language_id": "e3a3162e-35c1-428e-8af7-42802b757856",
"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-09-19T12:17:19.5259377+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "65927ef6-452f-477e-a7a9-58ae049fbc68",
"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": "9db2cf9d-69db-4c02-b306-67332c195d17",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3cd12c99-7732-42d3-9125-8607af3ef190"
},
"suggested_date_start": "2026-09-19T12:17:19.5259377+00:00",
"skill_id": "3d0d2591-993e-43c1-8d20-26b337d99397",
"skill_code": "sample string 32",
"skill": {
"id": "198c013e-4fcd-4e8f-b0b5-dfaac9070ef6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "904afa91-663c-41f0-bff7-db166ea941ce",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "05bd6be7-c4e8-4e8e-8c5e-33fb564e1718",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41195652-ee1f-49b0-96fc-cbad9d7f6fb2",
"db_currency_id": "f86533a8-a4ed-4c87-a5d5-5c15a5982da2",
"db_language_id": "e3a3162e-35c1-428e-8af7-42802b757856",
"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-09-19T12:17:19.5259377+00:00"
},
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3110fc1d-852a-4bfe-b516-aa489d29e5dd",
"date_reported_by_company": "2026-09-19T12:17:19.5259377+00:00",
"id2": 36,
"company_id": "4581e485-371d-43f6-9ab9-0d78ecb2c4a0",
"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": "ed4a09c2-673e-4533-b621-d1e26a2320bc",
"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-09-19T12:17:19.5259377+00:00"
},
"work_instruction_details_id": "01d43963-0bf4-462d-ae44-b72c1daac7a7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fdedea20-8dc5-4f25-b082-56ed58c215d4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e9112aba-8dc3-4bab-aa72-2ee1f15ce3b2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-19T12:17:19.5259377+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": "7c71e4ef-b279-4284-812f-05e5726f8de4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-19T12:17:19.5259377+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.