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": "df873d39-f575-4aeb-93ba-a5711f8402eb",
"jobs_id": "9734c438-5835-42ec-b9a9-c468c9ee3c71",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ed2a175c-6d85-4eab-9add-3ab102ba5ef0",
"_parent_id": "0d0daaec-4b3b-47a0-a845-f4bfad7507d6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "42d65195-73c4-497c-b0a7-39b1f8bd881b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "37a46943-6e6a-4847-ba4c-71e5a0a7ee04",
"_parent_id": "cb3f1a29-cfa8-4d1c-8549-ad27d6d3e411",
"root_parent_id": "d8e1fc29-0e35-4baf-9526-ae9058f433b4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "25dffabc-5cb3-4cef-b158-423295c8b9e5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9d7b4d09-3a40-4bc3-b9c8-56431d7108da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e0cc6124-30bf-45ee-ac97-8203646a0805",
"_parent_code": "sample string 6",
"sales_organization_id": "9f951a59-b64f-470d-8926-35e5c91bd94d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "06b9123c-b0bf-4ec3-b0ca-d60a6b7093c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b3acdc2-3aed-42aa-9ffe-1f06f5d836cd",
"db_currency_id": "bd123178-8bb2-4b02-930e-7d1fde2ed237",
"db_language_id": "4c5f8ee5-7470-4c37-bcdb-c23cbb68c51e",
"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-08-31T20:55:10.9839609+00:00"
},
"modified_dateutc": "2026-08-31T20:55:10.9839609+00:00"
},
"equipment_model_id": "ffa93ca9-6fed-4dec-a264-f58cc665eda5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2523bedf-7702-440e-b7e2-ec71e2255806",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "84522f87-3e60-4b31-a5c4-323f1bfd9284",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3dc17724-5087-4093-a468-efc3674df697",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0209227e-eb8a-457a-b88d-cd38c2c4b698",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "06b9123c-b0bf-4ec3-b0ca-d60a6b7093c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b3acdc2-3aed-42aa-9ffe-1f06f5d836cd",
"db_currency_id": "bd123178-8bb2-4b02-930e-7d1fde2ed237",
"db_language_id": "4c5f8ee5-7470-4c37-bcdb-c23cbb68c51e",
"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-08-31T20:55:10.9839609+00:00"
},
"modified_dateutc": "2026-08-31T20:55:10.9839609+00:00"
},
"equipment_family_id": "b783b37f-740c-49b5-8969-36f015e18381",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9d7b4d09-3a40-4bc3-b9c8-56431d7108da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e0cc6124-30bf-45ee-ac97-8203646a0805",
"_parent_code": "sample string 6",
"sales_organization_id": "9f951a59-b64f-470d-8926-35e5c91bd94d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "06b9123c-b0bf-4ec3-b0ca-d60a6b7093c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b3acdc2-3aed-42aa-9ffe-1f06f5d836cd",
"db_currency_id": "bd123178-8bb2-4b02-930e-7d1fde2ed237",
"db_language_id": "4c5f8ee5-7470-4c37-bcdb-c23cbb68c51e",
"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-08-31T20:55:10.9839609+00:00"
},
"modified_dateutc": "2026-08-31T20:55:10.9839609+00:00"
},
"date_in_production_since": "2026-08-31T20:55:10.9839609+00:00",
"date_out_of_production_since": "2026-08-31T20:55:10.9839609+00:00",
"date_end_support": "2026-08-31T20:55:10.9839609+00:00",
"sales_organization_id": "b3f59333-e14c-4259-9e46-dcf27a2f3ea1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "06b9123c-b0bf-4ec3-b0ca-d60a6b7093c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b3acdc2-3aed-42aa-9ffe-1f06f5d836cd",
"db_currency_id": "bd123178-8bb2-4b02-930e-7d1fde2ed237",
"db_language_id": "4c5f8ee5-7470-4c37-bcdb-c23cbb68c51e",
"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-08-31T20:55:10.9839609+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-08-31T20:55:10.9839609+00:00"
},
"project_status_id": "294971ee-519c-4e9d-a0cc-06c6891014b4",
"project_status_code": "sample string 10",
"project_status": {
"id": "4fe36358-66ab-4c1a-b86f-fcf9ce26d9cb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bcb59cb1-4ffa-4ea6-90bd-c3b9be9c8a02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "06b9123c-b0bf-4ec3-b0ca-d60a6b7093c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b3acdc2-3aed-42aa-9ffe-1f06f5d836cd",
"db_currency_id": "bd123178-8bb2-4b02-930e-7d1fde2ed237",
"db_language_id": "4c5f8ee5-7470-4c37-bcdb-c23cbb68c51e",
"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-08-31T20:55:10.9839609+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T20:55:10.9839609+00:00"
},
"company_id": "61503603-b997-4317-b9e2-f0d3d3cfb9d7",
"company_code": "sample string 12",
"db_address_id": "12c03179-0c6e-4ec3-8d59-5b791653ec01",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e81fb569-3049-424e-a61d-cf7a3aab703b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bb26c089-3197-4f14-b9dc-4d65296c5b7a",
"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-08-31T20:55:10.9839609+00:00",
"date_create": "2026-08-31T20:55:10.9839609+00:00",
"date_update": "2026-08-31T20:55:10.9839609+00:00",
"updated_by_user_id": "14aae4cd-8342-4c9a-92a9-9fdb585b27dd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-31T20:55:10.9839609+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-08-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-31T20:55:10.9839609+00:00",
"date_last_job": "2026-08-31T20:55:10.9839609+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-31T20:55:10.9995845+00:00",
"modified_dateutc": "2026-08-31T20:55:10.9995845+00:00",
"is_mobile_installation": true
},
"job_type_id": "229859c9-ecdf-4540-a726-f0f8deb21b57",
"job_type_code": "sample string 7",
"job_type": {
"id": "37ac65bc-a833-40c0-af12-28fd3dd9b223",
"name": "sample string 2",
"sales_organization_id": "c55f2a24-156a-4356-9fcf-30d445167417",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-31T20:55:10.9995845+00:00",
"code": "sample string 7"
},
"job_priority_id": "e9badc0a-12f0-427e-b69a-5314de7a96cd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2aa709c0-53c4-4ec5-a4e8-37789f21ff04",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2e7924d8-5cc9-486f-a20f-7e375fdbf430",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "06b9123c-b0bf-4ec3-b0ca-d60a6b7093c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b3acdc2-3aed-42aa-9ffe-1f06f5d836cd",
"db_currency_id": "bd123178-8bb2-4b02-930e-7d1fde2ed237",
"db_language_id": "4c5f8ee5-7470-4c37-bcdb-c23cbb68c51e",
"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-08-31T20:55:10.9839609+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T20:55:10.9995845+00:00"
},
"job_status_id": "4da8e180-6888-4a82-83eb-a221d26199dd",
"job_status_code": "sample string 11",
"db_address_id": "ae07d721-2f98-4497-9dd9-e1d1f54ee258",
"contact_id": "e2d71177-becf-4c28-8910-c758dbca203e",
"requested_by_company_id": "2645e5a4-4153-4638-8e20-4c60d288e9d5",
"requested_by_contact_id": "8d6500f9-d572-4493-b2a5-15945e4d59b9",
"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-08-31T20:55:10.9995845+00:00",
"due_date": "2026-08-31T20:55:10.9995845+00:00",
"date_create": "2026-08-31T20:55:10.9995845+00:00",
"date_update": "2026-08-31T20:55:10.9995845+00:00",
"date_closed": "2026-08-31T20:55:10.9995845+00:00",
"suggested_user_id": "ca3b2722-fa1e-42d7-ae51-b66e53099d71",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4318ac2f-19e1-4106-9315-d5e4de1fa602",
"db_language_id": "c4446963-23a9-4934-b58e-98272935b924",
"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-08-31T20:55:10.9995845+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e4ace457-ee88-46c2-92f3-d407eaef8a00",
"sales_organization": {
"id": "06b9123c-b0bf-4ec3-b0ca-d60a6b7093c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b3acdc2-3aed-42aa-9ffe-1f06f5d836cd",
"db_currency_id": "bd123178-8bb2-4b02-930e-7d1fde2ed237",
"db_language_id": "4c5f8ee5-7470-4c37-bcdb-c23cbb68c51e",
"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-08-31T20:55:10.9839609+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "214b967a-fdcb-4bb2-9a42-d14cab7b5b7d",
"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": "9f3c5c15-f7dd-47b3-977e-0fe80a62beb9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-31T20:55:10.9995845+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dce994cc-5805-438d-a0e4-3bf5e025aa84"
},
"suggested_date_start": "2026-08-31T20:55:10.9995845+00:00",
"skill_id": "c26522b7-7d15-4d82-9907-82d07e3bab87",
"skill_code": "sample string 32",
"skill": {
"id": "9d2f50bc-7a78-4213-a54b-c85cc5146afa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "34b66cce-6a4f-4198-9a65-77492e32f8a9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "06b9123c-b0bf-4ec3-b0ca-d60a6b7093c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b3acdc2-3aed-42aa-9ffe-1f06f5d836cd",
"db_currency_id": "bd123178-8bb2-4b02-930e-7d1fde2ed237",
"db_language_id": "4c5f8ee5-7470-4c37-bcdb-c23cbb68c51e",
"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-08-31T20:55:10.9839609+00:00"
},
"modified_dateutc": "2026-08-31T20:55:10.9995845+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fab88020-6e9b-4113-af55-f157821bd90a",
"date_reported_by_company": "2026-08-31T20:55:10.9995845+00:00",
"id2": 36,
"company_id": "064291bf-e4e6-4734-8457-e3eeb374f35a",
"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": "ebe825c3-5772-4f8a-9835-95a40f171436",
"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-08-31T20:55:10.9995845+00:00"
},
"work_instruction_details_id": "01c33edd-4f0d-4ab3-a50f-53e7fb33813d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1fd760ad-3ee2-4a50-a438-f716de8acd69",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c6748dae-261c-4046-a155-adcf4aaa73e4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-31T20:55:10.9995845+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": "4047d603-a573-424f-be6a-e484eaaeb9d1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-31T20:55:10.9995845+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.