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": "a4801cc0-d93f-46f1-bbf3-79fad429be1b",
"jobs_id": "a75a381d-b508-4295-86ec-436bb1926d82",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "18182e0d-552a-4cfe-9790-6942c32d2f81",
"_parent_id": "0c4f31f7-3917-4ca3-8a60-29e3958bff46",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e66b39d5-58b6-4b74-b373-89dda4048220",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d2fc8356-784c-46c3-bff5-ace693097df2",
"_parent_id": "8a90ae00-a2d9-4f12-a1fa-bec28bae21e2",
"root_parent_id": "ab2b4e01-4f12-49e5-86b4-e4ce41236805",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "88775e30-4cce-4b9e-9d95-36cb945ce9f5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "61ae08ca-f3f3-4de4-9a78-3da1e4722239",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5efa8b47-908f-4eec-9c58-bb0f494a33c5",
"_parent_code": "sample string 6",
"sales_organization_id": "ae2230d6-949c-4c04-be85-ed8d8332e696",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f409ffe6-51cd-4b34-8812-9fb4508da350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6374bfd6-0283-44fc-acf1-0f9b0d130473",
"db_currency_id": "c03d01a7-9a41-47fb-b894-48c84d6f38c2",
"db_language_id": "fcc55d7c-8d1d-4d44-be27-8a95de974bad",
"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-13T05:23:20.993101+00:00"
},
"modified_dateutc": "2026-04-13T05:23:20.993101+00:00"
},
"equipment_model_id": "39086b0f-8e4d-4196-a4e6-a66e2949c650",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "021aaed6-504f-4e0d-989c-9f5581831fb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "624ffaad-b444-4c33-b43c-2a7850fffef0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "32ca1dc9-962e-4f9a-9f29-9222b4764c78",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "70bea613-4f6e-403d-8043-bb9e93448eca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f409ffe6-51cd-4b34-8812-9fb4508da350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6374bfd6-0283-44fc-acf1-0f9b0d130473",
"db_currency_id": "c03d01a7-9a41-47fb-b894-48c84d6f38c2",
"db_language_id": "fcc55d7c-8d1d-4d44-be27-8a95de974bad",
"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-13T05:23:20.993101+00:00"
},
"modified_dateutc": "2026-04-13T05:23:21.0087255+00:00"
},
"equipment_family_id": "f5584616-041c-431a-bd80-e54a660ed318",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "61ae08ca-f3f3-4de4-9a78-3da1e4722239",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5efa8b47-908f-4eec-9c58-bb0f494a33c5",
"_parent_code": "sample string 6",
"sales_organization_id": "ae2230d6-949c-4c04-be85-ed8d8332e696",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f409ffe6-51cd-4b34-8812-9fb4508da350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6374bfd6-0283-44fc-acf1-0f9b0d130473",
"db_currency_id": "c03d01a7-9a41-47fb-b894-48c84d6f38c2",
"db_language_id": "fcc55d7c-8d1d-4d44-be27-8a95de974bad",
"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-13T05:23:20.993101+00:00"
},
"modified_dateutc": "2026-04-13T05:23:20.993101+00:00"
},
"date_in_production_since": "2026-04-13T05:23:21.0087255+00:00",
"date_out_of_production_since": "2026-04-13T05:23:21.0087255+00:00",
"date_end_support": "2026-04-13T05:23:21.0087255+00:00",
"sales_organization_id": "9a7bec77-2678-4513-b44b-a04346a34503",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f409ffe6-51cd-4b34-8812-9fb4508da350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6374bfd6-0283-44fc-acf1-0f9b0d130473",
"db_currency_id": "c03d01a7-9a41-47fb-b894-48c84d6f38c2",
"db_language_id": "fcc55d7c-8d1d-4d44-be27-8a95de974bad",
"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-13T05:23:20.993101+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-13T05:23:21.0087255+00:00"
},
"project_status_id": "5ee74438-80df-445c-b950-30e7c08f22ce",
"project_status_code": "sample string 10",
"project_status": {
"id": "18cd0949-6238-4b43-a0a2-adc709d06cf4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "94fa6f87-38f5-4153-ac93-a00dfb7a04f5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f409ffe6-51cd-4b34-8812-9fb4508da350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6374bfd6-0283-44fc-acf1-0f9b0d130473",
"db_currency_id": "c03d01a7-9a41-47fb-b894-48c84d6f38c2",
"db_language_id": "fcc55d7c-8d1d-4d44-be27-8a95de974bad",
"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-13T05:23:20.993101+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-13T05:23:21.0087255+00:00"
},
"company_id": "98486708-5dc1-4b5a-887f-67196cff976f",
"company_code": "sample string 12",
"db_address_id": "14904f71-6d1f-4d06-9d60-3b0df857fc40",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "86f1c57f-f987-4437-ae6a-a541cae51293",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b977a7b8-a5d8-4e12-ae7f-0e3717c39897",
"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-13T05:23:21.0087255+00:00",
"date_create": "2026-04-13T05:23:21.0087255+00:00",
"date_update": "2026-04-13T05:23:21.0087255+00:00",
"updated_by_user_id": "265e66e5-f624-4fba-a86f-91efdf76cb25",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-13T05:23:21.0087255+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-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-13T05:23:21.0087255+00:00",
"date_last_job": "2026-04-13T05:23:21.0087255+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-13T05:23:21.0087255+00:00",
"modified_dateutc": "2026-04-13T05:23:21.0087255+00:00",
"is_mobile_installation": true
},
"job_type_id": "09fa27ed-ee0a-43cd-aece-6ba31964d416",
"job_type_code": "sample string 7",
"job_type": {
"id": "4b9ab4d6-512b-4146-99e6-ede4ff6ab8df",
"name": "sample string 2",
"sales_organization_id": "46bbb213-13ae-4a51-933c-aaa94ccc1536",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-13T05:23:21.0087255+00:00",
"code": "sample string 7"
},
"job_priority_id": "3bc2dbb2-6df7-4f52-b756-33c11d0d3523",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f2c50d10-dafb-4c3f-8564-b0198b483886",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "94d1d42d-97ca-4442-817b-4897041bf131",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f409ffe6-51cd-4b34-8812-9fb4508da350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6374bfd6-0283-44fc-acf1-0f9b0d130473",
"db_currency_id": "c03d01a7-9a41-47fb-b894-48c84d6f38c2",
"db_language_id": "fcc55d7c-8d1d-4d44-be27-8a95de974bad",
"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-13T05:23:20.993101+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-13T05:23:21.0087255+00:00"
},
"job_status_id": "006fc913-d978-4f5a-bc4a-2b7dfbcf9154",
"job_status_code": "sample string 11",
"db_address_id": "a2da9489-4706-4cc9-abf0-bd34e6f1616f",
"contact_id": "faab886b-574e-470e-864f-2e7efaa76e89",
"requested_by_company_id": "542eee7d-298a-4012-9a6b-11ece01d11e7",
"requested_by_contact_id": "95c85274-5e8e-48a9-97a2-20d114e607d6",
"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-13T05:23:21.0087255+00:00",
"due_date": "2026-04-13T05:23:21.0087255+00:00",
"date_create": "2026-04-13T05:23:21.0087255+00:00",
"date_update": "2026-04-13T05:23:21.0087255+00:00",
"date_closed": "2026-04-13T05:23:21.0087255+00:00",
"suggested_user_id": "676dc6b3-31dc-4111-b0d7-038860a2cbe8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c958c158-5b01-48a1-8b60-45b6bb010ca7",
"db_language_id": "5c7951dc-ca44-432a-ae9d-cedf0c04476f",
"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-13T05:23:21.0087255+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b4eda2e7-6daa-41e1-bf24-fa3d35ef458f",
"sales_organization": {
"id": "f409ffe6-51cd-4b34-8812-9fb4508da350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6374bfd6-0283-44fc-acf1-0f9b0d130473",
"db_currency_id": "c03d01a7-9a41-47fb-b894-48c84d6f38c2",
"db_language_id": "fcc55d7c-8d1d-4d44-be27-8a95de974bad",
"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-13T05:23:20.993101+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "08eab3f1-d297-4499-8c55-24ab5f81b5e0",
"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": "853de6b7-9bbf-49b6-a7ec-b917e17bb9dc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-13T05:23:21.0087255+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7a9a9df6-f5ec-48a5-baf5-c23bc3ac7093"
},
"suggested_date_start": "2026-04-13T05:23:21.0087255+00:00",
"skill_id": "781bcc23-dc8e-4e48-a18c-527463cf7bea",
"skill_code": "sample string 32",
"skill": {
"id": "159b62a0-4dee-479f-bd54-2cf25e63868a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "60fb9324-5001-4508-adb9-3b2ec7bb3948",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f409ffe6-51cd-4b34-8812-9fb4508da350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6374bfd6-0283-44fc-acf1-0f9b0d130473",
"db_currency_id": "c03d01a7-9a41-47fb-b894-48c84d6f38c2",
"db_language_id": "fcc55d7c-8d1d-4d44-be27-8a95de974bad",
"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-13T05:23:20.993101+00:00"
},
"modified_dateutc": "2026-04-13T05:23:21.0087255+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fb8455b1-f842-490a-b138-9485a9584ca3",
"date_reported_by_company": "2026-04-13T05:23:21.0087255+00:00",
"id2": 36,
"company_id": "aafbc9f2-3e1d-4aea-882a-58cec4039a0a",
"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": "015478cc-b951-4e22-9267-bedb1461de9a",
"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-13T05:23:21.0087255+00:00"
},
"work_instruction_details_id": "d26476d8-d2ac-4148-be8a-42f54f6fe784",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "029f69c9-5200-4725-ad1e-6849cabcb90f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dda8a101-2e81-4650-ab7e-27bba30556ca",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-13T05:23:21.0087255+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": "ccbcdf38-a450-49aa-9b19-f065fb29c18a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-13T05:23:21.0087255+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.