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": "25581a8d-3f58-41a3-b6fd-fbc6b085721b",
"jobs_id": "96a75a51-4267-4b5b-9985-12242ae64f5f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e0d054be-0ccf-470d-974f-4ec4ebd6d4f4",
"_parent_id": "a6c9802b-4a12-4907-8d7a-841a62f4957a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1e6e2a59-413a-426a-8b80-6448b7b9193c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c8a46703-a8a1-4779-9ad8-6531dfcdaa7a",
"_parent_id": "924de98b-fe06-4d11-9afa-41f80051c59a",
"root_parent_id": "6aad8093-e13a-4659-aa95-a8d7d00de640",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "be04779a-759d-42eb-b5c0-794db9929e72",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0f771d37-7024-49cf-84d7-d2d5d7ea6ab7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "176d6131-51e1-473e-adb3-c2b52b8cfc1a",
"_parent_code": "sample string 6",
"sales_organization_id": "11813273-746e-40d8-b606-cf682b5403d7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e481d77d-5cd0-47d7-8ad9-e7107ac054b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7464ad1f-561f-46c8-8648-575b977380bb",
"db_currency_id": "bda5a447-ec25-480a-8d58-594d88418146",
"db_language_id": "8b71bfca-f1d5-44d3-8f0b-e09763e6def0",
"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-02T12:34:01.0956764+00:00"
},
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00"
},
"equipment_model_id": "d5a7191b-205e-4f21-a4b9-660b1e58a8ed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6f89911d-cbe6-442b-a16e-616de95cd58b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3c139e12-60cc-4160-b570-aaf4d3649f3b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f629851d-683f-4b9c-868e-d8e9193891f2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e93d7733-11fe-43e3-b78d-9dcc28f9000a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e481d77d-5cd0-47d7-8ad9-e7107ac054b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7464ad1f-561f-46c8-8648-575b977380bb",
"db_currency_id": "bda5a447-ec25-480a-8d58-594d88418146",
"db_language_id": "8b71bfca-f1d5-44d3-8f0b-e09763e6def0",
"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-02T12:34:01.0956764+00:00"
},
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00"
},
"equipment_family_id": "37381e45-2298-402a-b219-f7b8450b004b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0f771d37-7024-49cf-84d7-d2d5d7ea6ab7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "176d6131-51e1-473e-adb3-c2b52b8cfc1a",
"_parent_code": "sample string 6",
"sales_organization_id": "11813273-746e-40d8-b606-cf682b5403d7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e481d77d-5cd0-47d7-8ad9-e7107ac054b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7464ad1f-561f-46c8-8648-575b977380bb",
"db_currency_id": "bda5a447-ec25-480a-8d58-594d88418146",
"db_language_id": "8b71bfca-f1d5-44d3-8f0b-e09763e6def0",
"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-02T12:34:01.0956764+00:00"
},
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00"
},
"date_in_production_since": "2026-07-02T12:34:01.0956764+00:00",
"date_out_of_production_since": "2026-07-02T12:34:01.0956764+00:00",
"date_end_support": "2026-07-02T12:34:01.0956764+00:00",
"sales_organization_id": "d3b3eb0f-c2c0-4924-ba1e-b9849a3edf9e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e481d77d-5cd0-47d7-8ad9-e7107ac054b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7464ad1f-561f-46c8-8648-575b977380bb",
"db_currency_id": "bda5a447-ec25-480a-8d58-594d88418146",
"db_language_id": "8b71bfca-f1d5-44d3-8f0b-e09763e6def0",
"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-02T12:34:01.0956764+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-02T12:34:01.0956764+00:00"
},
"project_status_id": "cc81736a-3f8b-4eca-bd8d-672ed80b8afa",
"project_status_code": "sample string 10",
"project_status": {
"id": "9fe28903-cbe0-4dc2-8004-86d76734ac99",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7c3a3a03-1b50-4fee-bb08-26a36023d6be",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e481d77d-5cd0-47d7-8ad9-e7107ac054b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7464ad1f-561f-46c8-8648-575b977380bb",
"db_currency_id": "bda5a447-ec25-480a-8d58-594d88418146",
"db_language_id": "8b71bfca-f1d5-44d3-8f0b-e09763e6def0",
"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-02T12:34:01.0956764+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00"
},
"company_id": "3b1e89e2-b286-41c4-9b2b-fb90a5d3c6e4",
"company_code": "sample string 12",
"db_address_id": "e8424836-44da-457f-ae40-d1fa40e208c4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "55899c75-a95b-4377-85a3-7e3d96404d34",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bda416ad-705f-4daa-a2ad-f9a45270906c",
"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-02T12:34:01.0956764+00:00",
"date_create": "2026-07-02T12:34:01.0956764+00:00",
"date_update": "2026-07-02T12:34:01.0956764+00:00",
"updated_by_user_id": "4903ea98-b1a9-42d3-b2ee-e4274779a6b7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-02T12:34:01.0956764+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-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-02T12:34:01.0956764+00:00",
"date_last_job": "2026-07-02T12:34:01.0956764+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-02T12:34:01.0956764+00:00",
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00",
"is_mobile_installation": true
},
"job_type_id": "f3ed7f72-3287-4a61-a094-59f9fd94e781",
"job_type_code": "sample string 7",
"job_type": {
"id": "2223b667-d691-4d7b-83c8-3628cfa4f4f4",
"name": "sample string 2",
"sales_organization_id": "bd5750b8-8030-4217-af48-1f60dfd4377c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00",
"code": "sample string 7"
},
"job_priority_id": "642f6697-22e0-4260-ad7c-7fc647d354a8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "28b17c73-6eea-434e-b45e-333ed822c7eb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dc257fa7-987a-4eb5-87ff-8354553656f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e481d77d-5cd0-47d7-8ad9-e7107ac054b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7464ad1f-561f-46c8-8648-575b977380bb",
"db_currency_id": "bda5a447-ec25-480a-8d58-594d88418146",
"db_language_id": "8b71bfca-f1d5-44d3-8f0b-e09763e6def0",
"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-02T12:34:01.0956764+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00"
},
"job_status_id": "b1e37793-8a66-47e2-b6e9-11027c480a0e",
"job_status_code": "sample string 11",
"db_address_id": "0a8f5978-b6b6-464d-bfc4-013c93eb4725",
"contact_id": "4d149b9e-290a-4a25-81b5-4996576b789b",
"requested_by_company_id": "be46195f-426f-4072-a28c-da9ae3fe033f",
"requested_by_contact_id": "136b7284-6741-4b24-b2cb-5ad34451d542",
"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-02T12:34:01.0956764+00:00",
"due_date": "2026-07-02T12:34:01.0956764+00:00",
"date_create": "2026-07-02T12:34:01.0956764+00:00",
"date_update": "2026-07-02T12:34:01.0956764+00:00",
"date_closed": "2026-07-02T12:34:01.0956764+00:00",
"suggested_user_id": "309e7a01-fe18-49c9-adf3-97f3219660ed",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2beb0120-f278-4a2b-a587-fd9cbf474e79",
"db_language_id": "b288473a-29e9-4e37-971c-839f9c213e91",
"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-02T12:34:01.0956764+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ee64908e-6b9d-4aa0-ae5c-408314b93047",
"sales_organization": {
"id": "e481d77d-5cd0-47d7-8ad9-e7107ac054b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7464ad1f-561f-46c8-8648-575b977380bb",
"db_currency_id": "bda5a447-ec25-480a-8d58-594d88418146",
"db_language_id": "8b71bfca-f1d5-44d3-8f0b-e09763e6def0",
"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-02T12:34:01.0956764+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6add1081-46dc-47a2-82b7-68b6d6539061",
"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": "75b32752-dc59-47fd-8956-0e313602b135",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b174e97c-a9bc-4112-9f2a-82bb8d0b4dc9"
},
"suggested_date_start": "2026-07-02T12:34:01.0956764+00:00",
"skill_id": "e3fd663a-ad14-4974-8932-aef4007ab298",
"skill_code": "sample string 32",
"skill": {
"id": "1dd5eee5-5a68-4a4b-874d-22a3392de2fa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d11c8e8d-bb72-4fea-822b-06f15c55a383",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e481d77d-5cd0-47d7-8ad9-e7107ac054b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7464ad1f-561f-46c8-8648-575b977380bb",
"db_currency_id": "bda5a447-ec25-480a-8d58-594d88418146",
"db_language_id": "8b71bfca-f1d5-44d3-8f0b-e09763e6def0",
"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-02T12:34:01.0956764+00:00"
},
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fbdb1752-4a6e-45c1-b1c3-13c72037b812",
"date_reported_by_company": "2026-07-02T12:34:01.0956764+00:00",
"id2": 36,
"company_id": "6fefaf81-7ea5-4e25-953b-4ca8d398b40c",
"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": "a53a9caf-b354-4433-a2e1-9c1d553c5e2e",
"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-02T12:34:01.0956764+00:00"
},
"work_instruction_details_id": "5ea41b06-7296-49ac-8619-81ac02300bf5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c1acf58e-fab0-4d39-9067-d731227d57cb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0df78ca0-9116-45b1-8cb2-202007f741e4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-02T12:34:01.0956764+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": "dea11144-18de-420e-8141-89c0f765c871",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-02T12:34:01.0956764+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.