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": "76bd6413-9d4b-47f5-bf9a-cdfe450d543e",
"jobs_id": "9916b7e4-4274-46e3-997e-20611700eff2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fb1b2b63-ae2b-4ab1-8cf3-490b62f3b4f8",
"_parent_id": "c13e9d28-67b3-4459-b801-a9c1f48770d0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "20b132d2-d57f-4174-bbc1-7fbeba36dfe9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4179a55c-75e7-4ca5-b47a-31402cdf66ce",
"_parent_id": "898e34b7-a803-483a-9002-8de8a5f12695",
"root_parent_id": "0ac8a09b-2efa-4369-967b-877b6dd29df5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "af5ac661-2374-4c24-b12b-2c65fa4b7192",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1f2de959-fc65-49ea-a2f1-8fadd108a6aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9e69e8bf-30f3-4bcc-b1e7-74f9b79b0902",
"_parent_code": "sample string 6",
"sales_organization_id": "d4ace305-3ea6-4e85-bd91-1b68f6301767",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b3c4413-00dc-4bb6-a879-0ee578617b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97617b40-4816-44a5-820b-a8fc92fefa29",
"db_currency_id": "a2cae5f3-68d7-4cae-bc91-0cecfe50d332",
"db_language_id": "acb76941-6d4d-4c27-8ba1-ce31312f51dd",
"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-16T09:54:51.1843972+00:00"
},
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00"
},
"equipment_model_id": "5f07814b-c68a-428b-a717-cef2ec74cd86",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "de0e2991-d1a2-4612-839c-bd43dd770dfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "114d54f3-56fe-4950-bf90-5debfd76f47d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "495c7c7b-e8bd-4cad-ab7e-e84f06ee0b7d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "80315e1c-7a96-4db6-b88a-abf68da3ad30",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2b3c4413-00dc-4bb6-a879-0ee578617b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97617b40-4816-44a5-820b-a8fc92fefa29",
"db_currency_id": "a2cae5f3-68d7-4cae-bc91-0cecfe50d332",
"db_language_id": "acb76941-6d4d-4c27-8ba1-ce31312f51dd",
"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-16T09:54:51.1843972+00:00"
},
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00"
},
"equipment_family_id": "bb392e77-b031-4195-a1f5-78efdbfac1f6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1f2de959-fc65-49ea-a2f1-8fadd108a6aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9e69e8bf-30f3-4bcc-b1e7-74f9b79b0902",
"_parent_code": "sample string 6",
"sales_organization_id": "d4ace305-3ea6-4e85-bd91-1b68f6301767",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b3c4413-00dc-4bb6-a879-0ee578617b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97617b40-4816-44a5-820b-a8fc92fefa29",
"db_currency_id": "a2cae5f3-68d7-4cae-bc91-0cecfe50d332",
"db_language_id": "acb76941-6d4d-4c27-8ba1-ce31312f51dd",
"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-16T09:54:51.1843972+00:00"
},
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00"
},
"date_in_production_since": "2026-07-16T09:54:51.1843972+00:00",
"date_out_of_production_since": "2026-07-16T09:54:51.1843972+00:00",
"date_end_support": "2026-07-16T09:54:51.1843972+00:00",
"sales_organization_id": "d6a82cc5-29a4-447a-805a-7c90bce8c3e4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2b3c4413-00dc-4bb6-a879-0ee578617b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97617b40-4816-44a5-820b-a8fc92fefa29",
"db_currency_id": "a2cae5f3-68d7-4cae-bc91-0cecfe50d332",
"db_language_id": "acb76941-6d4d-4c27-8ba1-ce31312f51dd",
"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-16T09:54:51.1843972+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-16T09:54:51.1843972+00:00"
},
"project_status_id": "fe3c7abb-bec9-4b26-b555-63d13f75b7be",
"project_status_code": "sample string 10",
"project_status": {
"id": "05aec5fb-a5dc-4258-958b-e9da93ca7a66",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "67d07956-4937-4b28-93ed-c2d5bf3cd486",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b3c4413-00dc-4bb6-a879-0ee578617b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97617b40-4816-44a5-820b-a8fc92fefa29",
"db_currency_id": "a2cae5f3-68d7-4cae-bc91-0cecfe50d332",
"db_language_id": "acb76941-6d4d-4c27-8ba1-ce31312f51dd",
"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-16T09:54:51.1843972+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00"
},
"company_id": "51220824-6e85-4614-8683-a74024bf581a",
"company_code": "sample string 12",
"db_address_id": "90fbb88c-c518-4249-a6d1-5f2b1b408521",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "aee33827-d421-4d64-9c87-3a62acef4d4e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d7e9a65c-9c86-43f1-adda-e690927f9381",
"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-16T09:54:51.1843972+00:00",
"date_create": "2026-07-16T09:54:51.1843972+00:00",
"date_update": "2026-07-16T09:54:51.1843972+00:00",
"updated_by_user_id": "0d305a6d-90d4-4e2c-adfa-890f409ab5d5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-16T09:54:51.1843972+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-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-16T09:54:51.1843972+00:00",
"date_last_job": "2026-07-16T09:54:51.1843972+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-16T09:54:51.1843972+00:00",
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00",
"is_mobile_installation": true
},
"job_type_id": "98e4b10b-4927-4a00-9007-94ca7ebe00b5",
"job_type_code": "sample string 7",
"job_type": {
"id": "70b1ad80-f6e1-4265-8f51-749f81dbefaf",
"name": "sample string 2",
"sales_organization_id": "2a352a9a-f740-4a07-9844-22a477129990",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00",
"code": "sample string 7"
},
"job_priority_id": "8a0c8876-4fc5-4ce4-8f4d-ae585401d35a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2a6513da-657f-44ef-a82c-dc6e41f84248",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "10bae1b7-8072-428e-abed-6c3da1666936",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b3c4413-00dc-4bb6-a879-0ee578617b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97617b40-4816-44a5-820b-a8fc92fefa29",
"db_currency_id": "a2cae5f3-68d7-4cae-bc91-0cecfe50d332",
"db_language_id": "acb76941-6d4d-4c27-8ba1-ce31312f51dd",
"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-16T09:54:51.1843972+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00"
},
"job_status_id": "741380ac-505d-4285-a857-6a15ba8a427b",
"job_status_code": "sample string 11",
"db_address_id": "ccc7e938-339d-4ed9-8319-a4fd213917a3",
"contact_id": "92d01961-83e3-4c6f-880a-29fbfa331248",
"requested_by_company_id": "730be098-ffe3-44ba-ac10-f8f42d9a52b2",
"requested_by_contact_id": "887c82af-fe8e-4c4d-a4b3-4a2eead3fa4d",
"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-16T09:54:51.1843972+00:00",
"due_date": "2026-07-16T09:54:51.1843972+00:00",
"date_create": "2026-07-16T09:54:51.1843972+00:00",
"date_update": "2026-07-16T09:54:51.1843972+00:00",
"date_closed": "2026-07-16T09:54:51.1843972+00:00",
"suggested_user_id": "b7a17afb-ecb9-417c-a001-fdfdb950b356",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4177e632-2674-4914-810c-10d85c24aeab",
"db_language_id": "0e70fa64-5204-403f-9e08-0bab5c5b3460",
"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-16T09:54:51.1843972+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6e139315-20ae-41d3-97ae-bab70f3c0480",
"sales_organization": {
"id": "2b3c4413-00dc-4bb6-a879-0ee578617b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97617b40-4816-44a5-820b-a8fc92fefa29",
"db_currency_id": "a2cae5f3-68d7-4cae-bc91-0cecfe50d332",
"db_language_id": "acb76941-6d4d-4c27-8ba1-ce31312f51dd",
"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-16T09:54:51.1843972+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9ef9a109-db80-429e-bb76-377ad9b60e90",
"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": "3d46d583-0160-4b3d-96a8-bbb12ec806a0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "82f13425-1384-44f9-bb54-ed540daade71"
},
"suggested_date_start": "2026-07-16T09:54:51.1843972+00:00",
"skill_id": "00209072-0460-434f-89f9-9591c75d0f70",
"skill_code": "sample string 32",
"skill": {
"id": "adb205ef-2175-40f2-8f30-e93e1a0a6481",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b7641a16-bd3e-4663-a948-9f91bc716265",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b3c4413-00dc-4bb6-a879-0ee578617b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97617b40-4816-44a5-820b-a8fc92fefa29",
"db_currency_id": "a2cae5f3-68d7-4cae-bc91-0cecfe50d332",
"db_language_id": "acb76941-6d4d-4c27-8ba1-ce31312f51dd",
"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-16T09:54:51.1843972+00:00"
},
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "90dcca54-594f-4005-a621-57ac8cd3efd6",
"date_reported_by_company": "2026-07-16T09:54:51.1843972+00:00",
"id2": 36,
"company_id": "88026cfc-2ac1-4c3c-8fb2-18d7fa4501dd",
"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": "3f3c3518-1d08-49db-9634-17cfe0c9c27b",
"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-16T09:54:51.1843972+00:00"
},
"work_instruction_details_id": "3b674abf-7b8c-45e4-ac95-7e15ebcdf6b3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7c71bc91-3dee-428e-9719-bb608a166767",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "61447bc3-4f91-4101-86ac-5a2aacce4402",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-16T09:54:51.1843972+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": "e9a056e8-5de6-47e4-aef1-4087abf89af4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-16T09:54:51.1843972+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.