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": "bc17aea9-2484-41e8-b236-426a2ae07280",
"jobs_id": "914e5693-f6c2-4da0-8357-786aeb098a8c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7bdd45ab-f14d-4bc8-99de-f6da2d3b6a14",
"_parent_id": "07d4b85b-6bd0-4738-b2d9-a340fd18b119",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "68b4eb7b-db88-4f93-b0a3-30975c822001",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8c87c5c7-5d9d-4d10-acfa-146c9c54783e",
"_parent_id": "7aa8f65e-6658-4c85-af41-8c38a3433f97",
"root_parent_id": "ee539dfc-351e-496a-a27d-19e4337883aa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1c126dc2-b740-4baa-a948-e763810fa0d5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a367099d-0c0f-4801-87e5-6927a03d0ecf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7c40d585-b6da-4d41-965b-a5451a4e9616",
"_parent_code": "sample string 6",
"sales_organization_id": "5ac2b9f5-252e-4183-bda7-c5a397dad14a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9d492734-1f5d-491e-b94f-e70d5188c4a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "789be52d-8e7f-4799-96e6-9f06ab70c269",
"db_currency_id": "56cebb3f-13b8-48e0-8104-622192b7ae29",
"db_language_id": "602acca6-e681-4f4d-97a5-ceb608d5fe86",
"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-10-08T11:13:00.249743+00:00"
},
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00"
},
"equipment_model_id": "28a80a7d-2df0-4369-940b-3fc1d557a0c1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3161b288-39fd-4eee-aaf6-82af5b3a7e0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8ce2e6f6-9e1c-422b-983b-3fca10fa1836",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4add35e6-aafd-41a2-a8e4-31ca3b85ce0c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "75aab038-a811-4281-84c6-c61dafadefe2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9d492734-1f5d-491e-b94f-e70d5188c4a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "789be52d-8e7f-4799-96e6-9f06ab70c269",
"db_currency_id": "56cebb3f-13b8-48e0-8104-622192b7ae29",
"db_language_id": "602acca6-e681-4f4d-97a5-ceb608d5fe86",
"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-10-08T11:13:00.249743+00:00"
},
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00"
},
"equipment_family_id": "fe10bbe6-e3a1-47fd-9746-bfb294dbc57b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a367099d-0c0f-4801-87e5-6927a03d0ecf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7c40d585-b6da-4d41-965b-a5451a4e9616",
"_parent_code": "sample string 6",
"sales_organization_id": "5ac2b9f5-252e-4183-bda7-c5a397dad14a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9d492734-1f5d-491e-b94f-e70d5188c4a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "789be52d-8e7f-4799-96e6-9f06ab70c269",
"db_currency_id": "56cebb3f-13b8-48e0-8104-622192b7ae29",
"db_language_id": "602acca6-e681-4f4d-97a5-ceb608d5fe86",
"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-10-08T11:13:00.249743+00:00"
},
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00"
},
"date_in_production_since": "2026-10-08T11:13:00.249743+00:00",
"date_out_of_production_since": "2026-10-08T11:13:00.249743+00:00",
"date_end_support": "2026-10-08T11:13:00.249743+00:00",
"sales_organization_id": "3322a2f5-daf2-4e8d-ac0e-56ff9139b987",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9d492734-1f5d-491e-b94f-e70d5188c4a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "789be52d-8e7f-4799-96e6-9f06ab70c269",
"db_currency_id": "56cebb3f-13b8-48e0-8104-622192b7ae29",
"db_language_id": "602acca6-e681-4f4d-97a5-ceb608d5fe86",
"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-10-08T11:13:00.249743+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-10-08T11:13:00.249743+00:00"
},
"project_status_id": "f026422c-9d6d-4637-896c-e4bac4552b0c",
"project_status_code": "sample string 10",
"project_status": {
"id": "c3b38b1a-a124-4eac-bb66-4ed53efe18cb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "070170cd-9bbc-4a05-ac38-1ba427aca69c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9d492734-1f5d-491e-b94f-e70d5188c4a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "789be52d-8e7f-4799-96e6-9f06ab70c269",
"db_currency_id": "56cebb3f-13b8-48e0-8104-622192b7ae29",
"db_language_id": "602acca6-e681-4f4d-97a5-ceb608d5fe86",
"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-10-08T11:13:00.249743+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00"
},
"company_id": "b3c63295-99e6-4909-b29e-5c0e964362f5",
"company_code": "sample string 12",
"db_address_id": "38ca9800-222e-4aa8-8825-e95b0a9c1df6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6d05da27-cc09-41f1-ba32-95a8d12b747b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6576534c-d96c-4ea4-9f0f-1e71979dc48a",
"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-10-08T11:13:00.249743+00:00",
"date_create": "2026-10-08T11:13:00.249743+00:00",
"date_update": "2026-10-08T11:13:00.249743+00:00",
"updated_by_user_id": "e07a1aad-ae42-43ad-8146-32f613a5f954",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T11:13:00.249743+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-10-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-08T11:13:00.249743+00:00",
"date_last_job": "2026-10-08T11:13:00.249743+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T11:13:00.249743+00:00",
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00",
"is_mobile_installation": true
},
"job_type_id": "00fbdea2-9898-4ca0-92ab-9dd29b3e0db7",
"job_type_code": "sample string 7",
"job_type": {
"id": "7b3e667f-059d-462d-a2f5-6f755d4cb3df",
"name": "sample string 2",
"sales_organization_id": "b72c2648-c2ac-4baa-992d-a6fc08fe2ed2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00",
"code": "sample string 7"
},
"job_priority_id": "d414ab7f-5f17-4463-9c82-486d6c2c1f9b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "14e37d52-b70d-4117-a546-98768bc7930a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dfe79505-428f-495c-aa9f-ea2e7ca19302",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9d492734-1f5d-491e-b94f-e70d5188c4a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "789be52d-8e7f-4799-96e6-9f06ab70c269",
"db_currency_id": "56cebb3f-13b8-48e0-8104-622192b7ae29",
"db_language_id": "602acca6-e681-4f4d-97a5-ceb608d5fe86",
"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-10-08T11:13:00.249743+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00"
},
"job_status_id": "fcc21951-0a57-481d-9243-98b03ed34b55",
"job_status_code": "sample string 11",
"db_address_id": "cbb23bdf-f28c-46a3-a1a6-6e11c09bc1f5",
"contact_id": "39263ba5-a8c0-4af4-9750-99d21c760fc9",
"requested_by_company_id": "7ddbc6da-d83a-4425-98a0-c1549a244d08",
"requested_by_contact_id": "d065b495-99d7-4c59-8ace-745ffeda90bc",
"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-10-08T11:13:00.249743+00:00",
"due_date": "2026-10-08T11:13:00.249743+00:00",
"date_create": "2026-10-08T11:13:00.249743+00:00",
"date_update": "2026-10-08T11:13:00.249743+00:00",
"date_closed": "2026-10-08T11:13:00.249743+00:00",
"suggested_user_id": "62e5866f-d892-4b8f-a30c-7892d0ee2a9e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d065c8a8-3f7f-4afc-a20f-4bd706d23298",
"db_language_id": "2341f850-7ca9-4edc-9629-f3d7ad26a0dc",
"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-10-08T11:13:00.249743+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "31afa17a-dd63-40b5-8add-3285cfc4dac9",
"sales_organization": {
"id": "9d492734-1f5d-491e-b94f-e70d5188c4a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "789be52d-8e7f-4799-96e6-9f06ab70c269",
"db_currency_id": "56cebb3f-13b8-48e0-8104-622192b7ae29",
"db_language_id": "602acca6-e681-4f4d-97a5-ceb608d5fe86",
"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-10-08T11:13:00.249743+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a0f2df29-e423-4918-8606-ad0637906f4f",
"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": "d8a8357a-3d27-4ae5-9cf7-1038e57aa531",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f4b79a30-0d8b-4880-b720-a78500e2b957"
},
"suggested_date_start": "2026-10-08T11:13:00.249743+00:00",
"skill_id": "af8ac6b8-bc7f-42fd-ac65-263d76d852c9",
"skill_code": "sample string 32",
"skill": {
"id": "8672d01b-2ed3-4a9f-b0ad-44e26c3ff8f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fc9e879f-39d0-45f2-af4e-78ea3b94c64e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9d492734-1f5d-491e-b94f-e70d5188c4a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "789be52d-8e7f-4799-96e6-9f06ab70c269",
"db_currency_id": "56cebb3f-13b8-48e0-8104-622192b7ae29",
"db_language_id": "602acca6-e681-4f4d-97a5-ceb608d5fe86",
"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-10-08T11:13:00.249743+00:00"
},
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4a641b45-9b42-49e1-84cf-39db9f8c7725",
"date_reported_by_company": "2026-10-08T11:13:00.249743+00:00",
"id2": 36,
"company_id": "aa04fc97-4be5-4fba-9963-c70ba84ece16",
"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": "1f17245e-02ed-4c91-9ef8-56a3170c5404",
"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-10-08T11:13:00.249743+00:00"
},
"work_instruction_details_id": "7e021b4f-a105-4d17-8226-804ecfd00e77",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b2a427c1-9876-4751-90a4-f2779f0a2fff",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "620c8918-618d-4d88-a6c5-62e59921d9ab",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T11:13:00.249743+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": "7dfb354a-af6f-4d36-a231-a7e52cd658af",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T11:13:00.249743+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.