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": "e20a324f-ac85-4cad-b934-3ef0cdf0f7f6",
"jobs_id": "b8fb3770-2d20-4f49-8558-2c93a516ff0e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c74e9f7d-9014-4be8-b284-7deb4c939497",
"_parent_id": "5b3ce797-c601-47c4-a707-ae5ccbfe82bb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aa5b0e78-259f-4ddc-bde6-37f4fdcfd762",
"project_reference_back_office": "sample string 5",
"project": {
"id": "033ecb5c-10bd-4f0c-a67c-0dca5e1b203c",
"_parent_id": "1f7af55e-7048-4176-96a9-7aa2b8fcb015",
"root_parent_id": "24e8433c-2a33-43ea-baef-763143ec501e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7b98e253-f024-4987-928d-479f13966279",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "455b0167-f7a0-4921-b7a4-0017bd9bfc08",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "03dfba34-af90-421c-a159-935b0845acb7",
"_parent_code": "sample string 6",
"sales_organization_id": "8f46b4c0-2f97-41e8-96fd-2f29fffca01b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0ea82d2d-6fdb-4a99-a622-a1c421430d4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1cae258-02af-47e4-a8f5-04ac2cbbb649",
"db_currency_id": "96e626cd-be3d-4a44-b037-4ceaa2aa8e7f",
"db_language_id": "9437ac94-35fc-4bdb-846c-3e00f3952832",
"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-13T09:21:54.4393402+00:00"
},
"modified_dateutc": "2026-07-13T09:21:54.4393402+00:00"
},
"equipment_model_id": "b3db819a-d90f-4131-aae3-920aae31472f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fa45c94a-f319-4341-a64f-02706bc8f1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6ed0ae30-92bf-4ce8-bf03-fdae9007d732",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "44cc9d37-daf5-4039-9cee-59d48171f534",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aedad45b-b025-4e3a-90d9-94044a4f5f61",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0ea82d2d-6fdb-4a99-a622-a1c421430d4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1cae258-02af-47e4-a8f5-04ac2cbbb649",
"db_currency_id": "96e626cd-be3d-4a44-b037-4ceaa2aa8e7f",
"db_language_id": "9437ac94-35fc-4bdb-846c-3e00f3952832",
"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-13T09:21:54.4393402+00:00"
},
"modified_dateutc": "2026-07-13T09:21:54.4393402+00:00"
},
"equipment_family_id": "c8a15b9d-3509-473a-bf35-fb989ac11151",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "455b0167-f7a0-4921-b7a4-0017bd9bfc08",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "03dfba34-af90-421c-a159-935b0845acb7",
"_parent_code": "sample string 6",
"sales_organization_id": "8f46b4c0-2f97-41e8-96fd-2f29fffca01b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0ea82d2d-6fdb-4a99-a622-a1c421430d4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1cae258-02af-47e4-a8f5-04ac2cbbb649",
"db_currency_id": "96e626cd-be3d-4a44-b037-4ceaa2aa8e7f",
"db_language_id": "9437ac94-35fc-4bdb-846c-3e00f3952832",
"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-13T09:21:54.4393402+00:00"
},
"modified_dateutc": "2026-07-13T09:21:54.4393402+00:00"
},
"date_in_production_since": "2026-07-13T09:21:54.4393402+00:00",
"date_out_of_production_since": "2026-07-13T09:21:54.4393402+00:00",
"date_end_support": "2026-07-13T09:21:54.4393402+00:00",
"sales_organization_id": "466bf4af-3a8b-49a8-b911-e4b8f4a43fb0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0ea82d2d-6fdb-4a99-a622-a1c421430d4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1cae258-02af-47e4-a8f5-04ac2cbbb649",
"db_currency_id": "96e626cd-be3d-4a44-b037-4ceaa2aa8e7f",
"db_language_id": "9437ac94-35fc-4bdb-846c-3e00f3952832",
"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-13T09:21:54.4393402+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-13T09:21:54.4393402+00:00"
},
"project_status_id": "d5ee4117-b350-4029-8904-80ad96f12148",
"project_status_code": "sample string 10",
"project_status": {
"id": "7cac4872-276a-43bb-8bb7-5bc5495fee92",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "21392ac5-4346-448c-9e39-585c7b2ef341",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0ea82d2d-6fdb-4a99-a622-a1c421430d4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1cae258-02af-47e4-a8f5-04ac2cbbb649",
"db_currency_id": "96e626cd-be3d-4a44-b037-4ceaa2aa8e7f",
"db_language_id": "9437ac94-35fc-4bdb-846c-3e00f3952832",
"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-13T09:21:54.4393402+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T09:21:54.4393402+00:00"
},
"company_id": "5b0a3c3e-b042-47da-acc2-8bdbb49e1ffc",
"company_code": "sample string 12",
"db_address_id": "e55f0c55-81d1-46af-bcba-dadd6c3bfb4c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "00fd7100-7b2b-42b5-aee7-05fc52865fb4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bf91e12b-d070-4a41-b011-7ec1b83d6051",
"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-13T09:21:54.4393402+00:00",
"date_create": "2026-07-13T09:21:54.4393402+00:00",
"date_update": "2026-07-13T09:21:54.4393402+00:00",
"updated_by_user_id": "e47e117f-f828-4b02-bac8-aca3daf76fd1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-13T09:21:54.4393402+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-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-13T09:21:54.4393402+00:00",
"date_last_job": "2026-07-13T09:21:54.4393402+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-13T09:21:54.4393402+00:00",
"modified_dateutc": "2026-07-13T09:21:54.4393402+00:00",
"is_mobile_installation": true
},
"job_type_id": "835225fe-75dd-4c42-adf3-5e932ca3caff",
"job_type_code": "sample string 7",
"job_type": {
"id": "dda6d35b-c75d-49aa-89f8-95a6a7c243a6",
"name": "sample string 2",
"sales_organization_id": "dc25cdb3-45f3-40b2-8c56-ed58f0860cc9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-13T09:21:54.4393402+00:00",
"code": "sample string 7"
},
"job_priority_id": "194a428b-c10f-4b0c-b5e7-f71cffbdc835",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9d5a60f3-72ed-4095-b262-ba1db6ddc049",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "79641137-b90b-415d-8101-9f3a5085f4d7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0ea82d2d-6fdb-4a99-a622-a1c421430d4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1cae258-02af-47e4-a8f5-04ac2cbbb649",
"db_currency_id": "96e626cd-be3d-4a44-b037-4ceaa2aa8e7f",
"db_language_id": "9437ac94-35fc-4bdb-846c-3e00f3952832",
"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-13T09:21:54.4393402+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T09:21:54.4393402+00:00"
},
"job_status_id": "5e887c5c-5c40-42c7-ab9c-a02cabbfd430",
"job_status_code": "sample string 11",
"db_address_id": "15c5a92e-e856-43dd-88d8-4a553abfcb72",
"contact_id": "75e0e5b7-0ed4-4bc4-85e0-703aa09ed2df",
"requested_by_company_id": "84d80cfc-2372-409d-a6ed-e700bdacef52",
"requested_by_contact_id": "9debbf6c-b310-4b21-bf1b-b0d895f696ee",
"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-13T09:21:54.4393402+00:00",
"due_date": "2026-07-13T09:21:54.4393402+00:00",
"date_create": "2026-07-13T09:21:54.4393402+00:00",
"date_update": "2026-07-13T09:21:54.4393402+00:00",
"date_closed": "2026-07-13T09:21:54.4393402+00:00",
"suggested_user_id": "aed73668-08ef-4645-8747-a54b4cc418bb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f82996b9-0d9b-4be0-afee-c732fa70bee5",
"db_language_id": "e685aa01-a47c-4170-a2e1-0fa1d0c3dd55",
"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-13T09:21:54.4393402+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7c2e55cf-354c-4096-9463-6e3ad207a0e7",
"sales_organization": {
"id": "0ea82d2d-6fdb-4a99-a622-a1c421430d4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1cae258-02af-47e4-a8f5-04ac2cbbb649",
"db_currency_id": "96e626cd-be3d-4a44-b037-4ceaa2aa8e7f",
"db_language_id": "9437ac94-35fc-4bdb-846c-3e00f3952832",
"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-13T09:21:54.4393402+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e2950bbd-1ec8-47fa-8385-d235a891e8f4",
"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": "1c2dc2e9-cb17-4c87-a77f-eb2fed8f9ba8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-13T09:21:54.4393402+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "124a25c7-4c81-446f-a5e9-773501b7a0f4"
},
"suggested_date_start": "2026-07-13T09:21:54.4393402+00:00",
"skill_id": "01d28e32-bd00-4765-b74c-d0289be54674",
"skill_code": "sample string 32",
"skill": {
"id": "68efbf2f-66f4-4efc-812c-65457fe5b749",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "95dc2ac4-0eeb-49eb-b6e3-a34339959b73",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0ea82d2d-6fdb-4a99-a622-a1c421430d4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e1cae258-02af-47e4-a8f5-04ac2cbbb649",
"db_currency_id": "96e626cd-be3d-4a44-b037-4ceaa2aa8e7f",
"db_language_id": "9437ac94-35fc-4bdb-846c-3e00f3952832",
"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-13T09:21:54.4393402+00:00"
},
"modified_dateutc": "2026-07-13T09:21:54.4393402+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dee302a0-c8e4-445e-be36-8a5ad577b4f7",
"date_reported_by_company": "2026-07-13T09:21:54.4393402+00:00",
"id2": 36,
"company_id": "acd6d426-4a56-4f60-9a8a-d78e486c93bb",
"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": "e153de2b-da7f-4773-8701-4557a5089024",
"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-13T09:21:54.4549643+00:00"
},
"work_instruction_details_id": "75a02121-9aee-4e91-8326-2f132d482eb8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0ead04e2-d4b7-4df5-9a7b-36351b0f3a2a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6eb38b3e-c7f0-4677-8fc2-6f4237d6a2d6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-13T09:21:54.4549643+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": "7f32910f-1007-4dfe-bf12-7090e1a5da08",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-13T09:21:54.4549643+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.