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": "cfd6bf33-645f-4d26-a2ad-d3a43e3bb744",
"jobs_id": "ae7b23df-2644-4470-a2fb-9ba5770d1587",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3415540c-ab4d-42af-960f-7ac0bbc92f90",
"_parent_id": "ea3651de-289a-4096-8688-7fb59dcaeec7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "03234de4-c3aa-4421-af1a-dfb65a042e93",
"project_reference_back_office": "sample string 5",
"project": {
"id": "13fe157b-3b58-471e-8643-afb6c3181a8f",
"_parent_id": "b660712c-d6b4-4a00-acc8-5fa1f65f568a",
"root_parent_id": "93d6cae9-babb-4187-b42a-4c5c1e994098",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9d7dd7a7-3128-486a-b74d-7766681f5aef",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ffc4e4aa-fbbd-46e0-a8fd-a282020a02c9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e6e9646-b8bf-4bc7-824f-494b860f25f4",
"_parent_code": "sample string 6",
"sales_organization_id": "387f653a-e4b0-4e6c-8322-6abce388517e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26fc6dda-6255-4110-a01d-1be8587cd225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e4270cb-3991-48e4-8326-9780bf48c808",
"db_currency_id": "8bb3e243-cf80-49ff-a05d-9db9840e4aa9",
"db_language_id": "abee4ca3-ef8c-4e91-9b26-f78596801956",
"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-01-24T05:53:29.9869227+00:00"
},
"modified_dateutc": "2026-01-24T05:53:29.9869227+00:00"
},
"equipment_model_id": "6edb0b35-c723-4fb9-b3a4-55db782b261c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6d7f6480-17eb-4ece-9de6-5b15d77b337d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "38410dcf-f2be-48b3-9243-2f90cb2ddb9a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "83c990dd-3b6c-44d1-83f3-8dfbdb995816",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bfa313e5-b84e-4388-847b-ea3ccce2d87a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "26fc6dda-6255-4110-a01d-1be8587cd225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e4270cb-3991-48e4-8326-9780bf48c808",
"db_currency_id": "8bb3e243-cf80-49ff-a05d-9db9840e4aa9",
"db_language_id": "abee4ca3-ef8c-4e91-9b26-f78596801956",
"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-01-24T05:53:29.9869227+00:00"
},
"modified_dateutc": "2026-01-24T05:53:29.9869227+00:00"
},
"equipment_family_id": "edad41b0-c0df-4d9d-8c7c-68043708cfac",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ffc4e4aa-fbbd-46e0-a8fd-a282020a02c9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7e6e9646-b8bf-4bc7-824f-494b860f25f4",
"_parent_code": "sample string 6",
"sales_organization_id": "387f653a-e4b0-4e6c-8322-6abce388517e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26fc6dda-6255-4110-a01d-1be8587cd225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e4270cb-3991-48e4-8326-9780bf48c808",
"db_currency_id": "8bb3e243-cf80-49ff-a05d-9db9840e4aa9",
"db_language_id": "abee4ca3-ef8c-4e91-9b26-f78596801956",
"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-01-24T05:53:29.9869227+00:00"
},
"modified_dateutc": "2026-01-24T05:53:29.9869227+00:00"
},
"date_in_production_since": "2026-01-24T05:53:29.9869227+00:00",
"date_out_of_production_since": "2026-01-24T05:53:29.9869227+00:00",
"date_end_support": "2026-01-24T05:53:29.9869227+00:00",
"sales_organization_id": "efbc4b14-082f-4cb3-ad41-ae5088ba5b7c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "26fc6dda-6255-4110-a01d-1be8587cd225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e4270cb-3991-48e4-8326-9780bf48c808",
"db_currency_id": "8bb3e243-cf80-49ff-a05d-9db9840e4aa9",
"db_language_id": "abee4ca3-ef8c-4e91-9b26-f78596801956",
"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-01-24T05:53:29.9869227+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-01-24T05:53:30.0025468+00:00"
},
"project_status_id": "643084de-d3b5-47b0-8c35-53707cdea5c1",
"project_status_code": "sample string 10",
"project_status": {
"id": "c010cb9e-9524-467b-97cb-5db7c1061b0f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "60f9c476-5807-40a9-9045-107097a519f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26fc6dda-6255-4110-a01d-1be8587cd225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e4270cb-3991-48e4-8326-9780bf48c808",
"db_currency_id": "8bb3e243-cf80-49ff-a05d-9db9840e4aa9",
"db_language_id": "abee4ca3-ef8c-4e91-9b26-f78596801956",
"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-01-24T05:53:29.9869227+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T05:53:30.0025468+00:00"
},
"company_id": "a1153d6a-7378-4d39-8fdc-7061f44e860c",
"company_code": "sample string 12",
"db_address_id": "ac366f62-876f-4fa1-8e24-9b7b1cf589a9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9e66899d-ba68-46cf-a1ae-0268f220ecb5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "275ad952-cd9b-4875-82ce-4c697f766a2f",
"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-01-24T05:53:30.0025468+00:00",
"date_create": "2026-01-24T05:53:30.0025468+00:00",
"date_update": "2026-01-24T05:53:30.0025468+00:00",
"updated_by_user_id": "2d223eae-3108-4379-a5d8-e8d760a86f5e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-24T05:53:30.0025468+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-01-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-24T05:53:30.0025468+00:00",
"date_last_job": "2026-01-24T05:53:30.0025468+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-24T05:53:30.0025468+00:00",
"modified_dateutc": "2026-01-24T05:53:30.0025468+00:00",
"is_mobile_installation": true
},
"job_type_id": "2e22bef8-58dc-4afb-a69e-db3cdfa7a839",
"job_type_code": "sample string 7",
"job_type": {
"id": "b4f38e55-4522-4a38-bbaa-b52c59a8ee3b",
"name": "sample string 2",
"sales_organization_id": "e3c2b2c7-78f5-44be-99d7-52887ac1c376",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-24T05:53:30.0025468+00:00",
"code": "sample string 7"
},
"job_priority_id": "bcff443a-9c1b-4ee2-99a1-76d1468f3fe4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fcd3408e-ed4f-4798-853e-7ae3bed51bae",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "53ebbb54-8721-4143-9ed1-4e099e8d7cdc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26fc6dda-6255-4110-a01d-1be8587cd225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e4270cb-3991-48e4-8326-9780bf48c808",
"db_currency_id": "8bb3e243-cf80-49ff-a05d-9db9840e4aa9",
"db_language_id": "abee4ca3-ef8c-4e91-9b26-f78596801956",
"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-01-24T05:53:29.9869227+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T05:53:30.0025468+00:00"
},
"job_status_id": "160c88dc-6061-45cf-bc29-cd287ae9b413",
"job_status_code": "sample string 11",
"db_address_id": "5431f8d0-fe93-4cf1-b743-c089e08a7037",
"contact_id": "50ba17e2-4bba-4cc8-a990-45cc3b80eabc",
"requested_by_company_id": "4f1fa71b-9aa2-4aeb-8bef-5c10288434ae",
"requested_by_contact_id": "e36aacd7-92cb-4383-b5c3-bca135c107ff",
"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-01-24T05:53:30.0025468+00:00",
"due_date": "2026-01-24T05:53:30.0025468+00:00",
"date_create": "2026-01-24T05:53:30.0025468+00:00",
"date_update": "2026-01-24T05:53:30.0025468+00:00",
"date_closed": "2026-01-24T05:53:30.0025468+00:00",
"suggested_user_id": "fca90288-b6a5-435f-96da-8cbf8ed3ad2c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3ba6a49a-5a20-48b8-8395-9fe9db9466a4",
"db_language_id": "31b51a9c-379e-4469-993f-13d108d73dde",
"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-01-24T05:53:30.0025468+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "169d83f8-bbb8-45a4-b327-4771e4ecd5b3",
"sales_organization": {
"id": "26fc6dda-6255-4110-a01d-1be8587cd225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e4270cb-3991-48e4-8326-9780bf48c808",
"db_currency_id": "8bb3e243-cf80-49ff-a05d-9db9840e4aa9",
"db_language_id": "abee4ca3-ef8c-4e91-9b26-f78596801956",
"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-01-24T05:53:29.9869227+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "26c01d4c-6b93-48d4-b5d8-b8cb26e3edb9",
"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": "3917c058-c219-4fb4-a556-85d1768aafb0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-24T05:53:30.0025468+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e3f8f0f1-0f3e-4ec9-b31f-fa8d720f11b7"
},
"suggested_date_start": "2026-01-24T05:53:30.0025468+00:00",
"skill_id": "2e266649-f8fe-4c27-b76f-b91b93c2892e",
"skill_code": "sample string 32",
"skill": {
"id": "b7569bf7-7065-44f0-97c3-8dbaacf9908e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b239c2cc-d2d3-4bce-80ba-e4ed0bbf7298",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26fc6dda-6255-4110-a01d-1be8587cd225",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e4270cb-3991-48e4-8326-9780bf48c808",
"db_currency_id": "8bb3e243-cf80-49ff-a05d-9db9840e4aa9",
"db_language_id": "abee4ca3-ef8c-4e91-9b26-f78596801956",
"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-01-24T05:53:29.9869227+00:00"
},
"modified_dateutc": "2026-01-24T05:53:30.0181716+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "314c9134-d6bb-4b6a-8078-4aeb763d3193",
"date_reported_by_company": "2026-01-24T05:53:30.0181716+00:00",
"id2": 36,
"company_id": "44401f45-0ff7-45f3-9ebc-d9006e5c918a",
"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": "80b8035b-535b-4c35-8076-8fbfadb07865",
"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-01-24T05:53:30.0181716+00:00"
},
"work_instruction_details_id": "6cb6d3c1-67b1-46cb-96d3-fcccbf5afaf2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "02b27a48-b54d-4cb8-a5b0-0a563ba03f1b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "aaa4b11e-ccfe-4225-bdc2-bc3e2502d699",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-24T05:53:30.0181716+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": "864f6fe3-6e1d-412d-b78d-56eb69891752",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-24T05:53:30.0181716+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.