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": "2bc62e1a-fdac-4484-ba44-b644f5b02c3f",
"jobs_id": "7c47d248-fc6c-4227-8b39-bf3ef52d2a49",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "72418d6f-617d-46f9-98a7-e22d553f8616",
"_parent_id": "7e3b2875-9af5-4957-a936-6ca6bc99b717",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "caee0324-829f-430c-9a56-5fc9b078b803",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ff29bdb4-2814-45a6-82b7-4a1847e05e67",
"_parent_id": "23e0c4cd-3fa0-44d4-bb4a-10f5e4e2e083",
"root_parent_id": "430a621e-94da-4205-86ff-0eccfa575abd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7ed5d363-fad1-402e-917f-5f119077cc3e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b095e07c-c7e0-44cf-a8fe-521df3bf9d45",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dc3830d7-536a-4080-9c01-ea2eb09f87d0",
"_parent_code": "sample string 6",
"sales_organization_id": "31bc37b2-3baa-4bf6-8f81-ad131622162c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d01c1fb4-9552-42ae-b10e-2ac397a9d9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad77901-19a9-4acb-b56a-fec6ad173f68",
"db_currency_id": "b7771755-0fe3-4c37-bcbe-bb3a01739dc7",
"db_language_id": "fb65e081-c3d7-4a22-82ed-ceea7dade940",
"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-11T19:34:17.3910937+00:00"
},
"modified_dateutc": "2026-07-11T19:34:17.3910937+00:00"
},
"equipment_model_id": "e3cfef6c-09dd-4b5f-8a66-2c9d27a128ac",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "63f0d8b0-de20-4e59-887d-e114abe5f9f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "850f334e-b6e9-4c2f-8441-6be3887a9912",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "995d7e66-5646-4033-b9cd-f187b2186352",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fe7be40a-0ff0-44b3-8e8b-b4ec23c41572",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d01c1fb4-9552-42ae-b10e-2ac397a9d9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad77901-19a9-4acb-b56a-fec6ad173f68",
"db_currency_id": "b7771755-0fe3-4c37-bcbe-bb3a01739dc7",
"db_language_id": "fb65e081-c3d7-4a22-82ed-ceea7dade940",
"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-11T19:34:17.3910937+00:00"
},
"modified_dateutc": "2026-07-11T19:34:17.3910937+00:00"
},
"equipment_family_id": "765eb84e-6ec8-4ef7-a998-5f38cb021579",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b095e07c-c7e0-44cf-a8fe-521df3bf9d45",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dc3830d7-536a-4080-9c01-ea2eb09f87d0",
"_parent_code": "sample string 6",
"sales_organization_id": "31bc37b2-3baa-4bf6-8f81-ad131622162c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d01c1fb4-9552-42ae-b10e-2ac397a9d9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad77901-19a9-4acb-b56a-fec6ad173f68",
"db_currency_id": "b7771755-0fe3-4c37-bcbe-bb3a01739dc7",
"db_language_id": "fb65e081-c3d7-4a22-82ed-ceea7dade940",
"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-11T19:34:17.3910937+00:00"
},
"modified_dateutc": "2026-07-11T19:34:17.3910937+00:00"
},
"date_in_production_since": "2026-07-11T19:34:17.3910937+00:00",
"date_out_of_production_since": "2026-07-11T19:34:17.3910937+00:00",
"date_end_support": "2026-07-11T19:34:17.3910937+00:00",
"sales_organization_id": "3ffccbde-b0f8-4db7-a12a-5d17d5129262",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d01c1fb4-9552-42ae-b10e-2ac397a9d9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad77901-19a9-4acb-b56a-fec6ad173f68",
"db_currency_id": "b7771755-0fe3-4c37-bcbe-bb3a01739dc7",
"db_language_id": "fb65e081-c3d7-4a22-82ed-ceea7dade940",
"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-11T19:34:17.3910937+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-11T19:34:17.3910937+00:00"
},
"project_status_id": "89472e2d-bd83-48d1-8c0c-5115e3b7139b",
"project_status_code": "sample string 10",
"project_status": {
"id": "dce25129-e7d0-4217-8323-353838046671",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ed4ebb02-e64f-4ba6-bb78-77a2be2a9ba6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d01c1fb4-9552-42ae-b10e-2ac397a9d9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad77901-19a9-4acb-b56a-fec6ad173f68",
"db_currency_id": "b7771755-0fe3-4c37-bcbe-bb3a01739dc7",
"db_language_id": "fb65e081-c3d7-4a22-82ed-ceea7dade940",
"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-11T19:34:17.3910937+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T19:34:17.3910937+00:00"
},
"company_id": "bb021721-4193-44c9-9a6c-020c195982a6",
"company_code": "sample string 12",
"db_address_id": "e271070d-be73-42d9-b923-b4b1a8e63406",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "67794636-233c-4f21-9d18-b1ae7c32d217",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "057ade8d-05f9-403c-b8d4-9e4e30a7f783",
"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-11T19:34:17.3910937+00:00",
"date_create": "2026-07-11T19:34:17.3910937+00:00",
"date_update": "2026-07-11T19:34:17.3910937+00:00",
"updated_by_user_id": "3bca807f-0839-4f0b-be5b-31f468e1558f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-11T19:34:17.3910937+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-11T19:34:17.3910937+00:00",
"date_last_job": "2026-07-11T19:34:17.3910937+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-11T19:34:17.3910937+00:00",
"modified_dateutc": "2026-07-11T19:34:17.3910937+00:00",
"is_mobile_installation": true
},
"job_type_id": "a39d5318-e86b-4df0-9380-5c0694098d7f",
"job_type_code": "sample string 7",
"job_type": {
"id": "d6753ea7-faf3-4c71-b636-47038565c52c",
"name": "sample string 2",
"sales_organization_id": "f106d51f-953c-4317-b217-cccf22caf360",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-11T19:34:17.3910937+00:00",
"code": "sample string 7"
},
"job_priority_id": "76bb0b94-c4e7-4985-b6b4-f9e0db15e423",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cfebf048-56c8-4459-8f6a-596eadef6d19",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7d30df29-eefd-4d34-a00c-d52340c179e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d01c1fb4-9552-42ae-b10e-2ac397a9d9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad77901-19a9-4acb-b56a-fec6ad173f68",
"db_currency_id": "b7771755-0fe3-4c37-bcbe-bb3a01739dc7",
"db_language_id": "fb65e081-c3d7-4a22-82ed-ceea7dade940",
"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-11T19:34:17.3910937+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T19:34:17.406711+00:00"
},
"job_status_id": "3c026490-8058-46aa-a119-776c9af7b404",
"job_status_code": "sample string 11",
"db_address_id": "a38b7181-b5ea-478b-868e-305cf6376193",
"contact_id": "fb2e91b3-c8d5-448b-89f3-9c57a21ee435",
"requested_by_company_id": "1b79cc3f-f7e1-46d4-8761-5c5bff0fcfb7",
"requested_by_contact_id": "328b5793-dd7c-4e47-97c8-183efb1caf6b",
"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-11T19:34:17.406711+00:00",
"due_date": "2026-07-11T19:34:17.406711+00:00",
"date_create": "2026-07-11T19:34:17.406711+00:00",
"date_update": "2026-07-11T19:34:17.406711+00:00",
"date_closed": "2026-07-11T19:34:17.406711+00:00",
"suggested_user_id": "ef0948e9-b98b-4fff-81c4-aface222a06c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "840b0532-574d-4394-ad21-3366ca6ce49b",
"db_language_id": "54cf4cac-bea8-4753-9dbe-025444979d33",
"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-11T19:34:17.406711+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0203c56d-d774-4608-8a22-90a588a3b741",
"sales_organization": {
"id": "d01c1fb4-9552-42ae-b10e-2ac397a9d9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad77901-19a9-4acb-b56a-fec6ad173f68",
"db_currency_id": "b7771755-0fe3-4c37-bcbe-bb3a01739dc7",
"db_language_id": "fb65e081-c3d7-4a22-82ed-ceea7dade940",
"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-11T19:34:17.3910937+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d8f8a10d-603f-4b4d-ab1e-962a4817af19",
"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": "96669a2b-44c6-4220-b1e4-2a58ddfa881d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-11T19:34:17.406711+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d5558c56-d0f8-435f-bed4-560a28ac0947"
},
"suggested_date_start": "2026-07-11T19:34:17.406711+00:00",
"skill_id": "f826ee0f-cb44-426a-b0cc-b47c4c780443",
"skill_code": "sample string 32",
"skill": {
"id": "31a3a9d1-00a6-43d7-9193-8fe916f0ec48",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5edf9807-a9f1-494d-ac47-de2eb2bc8e68",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d01c1fb4-9552-42ae-b10e-2ac397a9d9ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad77901-19a9-4acb-b56a-fec6ad173f68",
"db_currency_id": "b7771755-0fe3-4c37-bcbe-bb3a01739dc7",
"db_language_id": "fb65e081-c3d7-4a22-82ed-ceea7dade940",
"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-11T19:34:17.3910937+00:00"
},
"modified_dateutc": "2026-07-11T19:34:17.406711+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "91355dd4-2be8-4d63-8f99-899fdb84d908",
"date_reported_by_company": "2026-07-11T19:34:17.406711+00:00",
"id2": 36,
"company_id": "c8dd9581-43bc-4430-9e94-32a5d1660a25",
"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": "d49e6737-bfe7-4b97-b308-c4fd35113c13",
"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-11T19:34:17.406711+00:00"
},
"work_instruction_details_id": "5ee4d09c-313f-449f-9176-19dda8bddb53",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "11af527e-6cf6-4934-948d-20f4f0b81daf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a104e545-34bf-45ce-8358-6d3a10762234",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-11T19:34:17.406711+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": "974bbf86-129e-4eb4-a583-ddf0465c73d0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-11T19:34:17.406711+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.