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": "e4af7015-2132-4def-a144-9bfb4de6829b",
"jobs_id": "d5523cc1-6c7b-45ec-b87c-1035a733dcb8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "29040536-d178-47f2-ad24-e8456b8b794a",
"_parent_id": "2127f71f-35e4-4d32-ab8e-84d890e8ab1d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "65d2b9c4-3b2b-40f8-9f52-70ccb1037b0c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c0cc4161-0388-4299-b262-c70e066c2502",
"_parent_id": "1fb3392f-f992-4667-bb79-cfbebce98436",
"root_parent_id": "0ba4389e-ed58-4a95-ad1e-24b4541c48d7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "145111d1-0df3-4507-8d8f-9ce46637dd62",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cf91d08f-685e-41fa-8ce7-3d7a758ed149",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1435acf2-8409-4736-a8c2-00b501bda8f6",
"_parent_code": "sample string 6",
"sales_organization_id": "ce7652f6-a5cc-4b45-8b83-e7f9de4eb37f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6513054a-8532-4005-9f36-a94031dc770a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d881b3f-ec46-474a-bfe1-578da01ad7d2",
"db_currency_id": "b51766ac-18f0-4959-ba47-92b0de0675de",
"db_language_id": "e9ac7924-d57e-4326-9cec-8f5068be6a40",
"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-05-16T21:08:13.4116549+00:00"
},
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00"
},
"equipment_model_id": "43b08263-b0a0-4e56-8ee1-144fcc05a6bb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a2bdaa2e-3a72-42de-920c-2218d4465fce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "46b5fe22-a9db-474f-a556-489467fbdb86",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "26a0cedd-f419-4049-9866-eb0243739191",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1dbc04f4-f278-4ccd-9264-c7cf5db100d4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6513054a-8532-4005-9f36-a94031dc770a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d881b3f-ec46-474a-bfe1-578da01ad7d2",
"db_currency_id": "b51766ac-18f0-4959-ba47-92b0de0675de",
"db_language_id": "e9ac7924-d57e-4326-9cec-8f5068be6a40",
"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-05-16T21:08:13.4116549+00:00"
},
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00"
},
"equipment_family_id": "bda0d645-62d9-4c18-bdfb-3c7f36c8043e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cf91d08f-685e-41fa-8ce7-3d7a758ed149",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1435acf2-8409-4736-a8c2-00b501bda8f6",
"_parent_code": "sample string 6",
"sales_organization_id": "ce7652f6-a5cc-4b45-8b83-e7f9de4eb37f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6513054a-8532-4005-9f36-a94031dc770a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d881b3f-ec46-474a-bfe1-578da01ad7d2",
"db_currency_id": "b51766ac-18f0-4959-ba47-92b0de0675de",
"db_language_id": "e9ac7924-d57e-4326-9cec-8f5068be6a40",
"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-05-16T21:08:13.4116549+00:00"
},
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00"
},
"date_in_production_since": "2026-05-16T21:08:13.4116549+00:00",
"date_out_of_production_since": "2026-05-16T21:08:13.4116549+00:00",
"date_end_support": "2026-05-16T21:08:13.4116549+00:00",
"sales_organization_id": "6bdef1bc-fa41-4c92-b6c4-16c58d5f2d11",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6513054a-8532-4005-9f36-a94031dc770a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d881b3f-ec46-474a-bfe1-578da01ad7d2",
"db_currency_id": "b51766ac-18f0-4959-ba47-92b0de0675de",
"db_language_id": "e9ac7924-d57e-4326-9cec-8f5068be6a40",
"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-05-16T21:08:13.4116549+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-05-16T21:08:13.4116549+00:00"
},
"project_status_id": "f3432f83-3ce0-46ce-94ae-60de9300b17b",
"project_status_code": "sample string 10",
"project_status": {
"id": "4f1fccc7-d772-4f58-86cf-8266b0b01f8c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "543381ea-bebd-484c-ba7d-2e909a4c47b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6513054a-8532-4005-9f36-a94031dc770a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d881b3f-ec46-474a-bfe1-578da01ad7d2",
"db_currency_id": "b51766ac-18f0-4959-ba47-92b0de0675de",
"db_language_id": "e9ac7924-d57e-4326-9cec-8f5068be6a40",
"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-05-16T21:08:13.4116549+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00"
},
"company_id": "77736c76-71b9-4768-a9ea-5279b48fca9c",
"company_code": "sample string 12",
"db_address_id": "ba635c05-019a-4d9f-84de-77f6b5390081",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "03332300-9008-4830-b219-f25e6da79644",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "48eda9e9-c24e-46ea-81b4-7a3a953860f9",
"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-05-16T21:08:13.4116549+00:00",
"date_create": "2026-05-16T21:08:13.4116549+00:00",
"date_update": "2026-05-16T21:08:13.4116549+00:00",
"updated_by_user_id": "68390c51-5227-4c92-a579-84494c21c9bf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-16T21:08:13.4116549+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-05-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-16T21:08:13.4116549+00:00",
"date_last_job": "2026-05-16T21:08:13.4116549+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-16T21:08:13.4116549+00:00",
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00",
"is_mobile_installation": true
},
"job_type_id": "37c32324-10fb-4445-9c91-1c56183d1a8e",
"job_type_code": "sample string 7",
"job_type": {
"id": "e9550a98-b778-4a2b-913d-30978bcb05b3",
"name": "sample string 2",
"sales_organization_id": "8fe1b753-a233-41d6-9cfd-1dae5013ba26",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00",
"code": "sample string 7"
},
"job_priority_id": "f0e0b71f-8e22-4f1d-9db9-f6fef858fd80",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "77c1e335-02bc-47bc-bef8-c6337ba45a06",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ff1a6fda-8563-489b-a0b1-02630fceb93c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6513054a-8532-4005-9f36-a94031dc770a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d881b3f-ec46-474a-bfe1-578da01ad7d2",
"db_currency_id": "b51766ac-18f0-4959-ba47-92b0de0675de",
"db_language_id": "e9ac7924-d57e-4326-9cec-8f5068be6a40",
"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-05-16T21:08:13.4116549+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00"
},
"job_status_id": "53ebb3a8-1ddf-4d11-82c4-c7ac049d0ce5",
"job_status_code": "sample string 11",
"db_address_id": "580b3156-1e8e-4da4-b9c9-37156f2c3f3b",
"contact_id": "b4259f0d-7e60-41e1-854c-117a79f003ee",
"requested_by_company_id": "90a5f457-e3c3-40e7-aa83-cd8ed339f597",
"requested_by_contact_id": "e6adbab8-147b-4afe-a7d6-4e48f5de895b",
"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-05-16T21:08:13.4116549+00:00",
"due_date": "2026-05-16T21:08:13.4116549+00:00",
"date_create": "2026-05-16T21:08:13.4116549+00:00",
"date_update": "2026-05-16T21:08:13.4116549+00:00",
"date_closed": "2026-05-16T21:08:13.4116549+00:00",
"suggested_user_id": "c79b51fe-52c3-4695-ba6e-bb0ddb6e3d61",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "81ef466a-f058-41c8-b23f-642a7fe723ea",
"db_language_id": "5e161828-5407-409d-81ab-181bb8d48462",
"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-05-16T21:08:13.4116549+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "62b0a5f0-101b-4577-9a0b-d50c9e1d911e",
"sales_organization": {
"id": "6513054a-8532-4005-9f36-a94031dc770a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d881b3f-ec46-474a-bfe1-578da01ad7d2",
"db_currency_id": "b51766ac-18f0-4959-ba47-92b0de0675de",
"db_language_id": "e9ac7924-d57e-4326-9cec-8f5068be6a40",
"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-05-16T21:08:13.4116549+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b435a781-a330-40a9-a869-01e2f1bcaf97",
"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": "708f7e3e-741f-4532-b1b9-b32e07f01014",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2a7dd599-5bcb-4456-8136-47f33d1dd800"
},
"suggested_date_start": "2026-05-16T21:08:13.4116549+00:00",
"skill_id": "523c83dc-faf0-47ea-b186-8cbc340fa7f7",
"skill_code": "sample string 32",
"skill": {
"id": "aa2664d8-6679-4b2e-ba80-ce42df075c2e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e0026657-9d5a-4675-a29e-82779f576df8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6513054a-8532-4005-9f36-a94031dc770a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d881b3f-ec46-474a-bfe1-578da01ad7d2",
"db_currency_id": "b51766ac-18f0-4959-ba47-92b0de0675de",
"db_language_id": "e9ac7924-d57e-4326-9cec-8f5068be6a40",
"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-05-16T21:08:13.4116549+00:00"
},
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bf765a11-60ce-4d95-afbe-17930db7c7df",
"date_reported_by_company": "2026-05-16T21:08:13.4116549+00:00",
"id2": 36,
"company_id": "9fcb30b1-7c0c-4233-a1e0-0934a4aedd0b",
"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": "4c7a6d74-faa4-43bf-9f08-c29963413c71",
"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-05-16T21:08:13.4116549+00:00"
},
"work_instruction_details_id": "f437cb1d-9cb9-482e-a199-c39b98c974df",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4b099086-8339-4a36-801a-e41168308b4b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "443ec6fd-55af-4ffb-afad-918b939ba64d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-16T21:08:13.4116549+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": "78258271-6c4f-4b95-8dd4-51adbca19b8d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-16T21:08:13.4116549+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.