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": "ba643067-0717-4276-bfd6-c6642100c70a",
"jobs_id": "ee76a1ad-6e28-430f-ac15-6288aa1c599a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2631dd0c-bf1a-41f0-a613-c3812828ec07",
"_parent_id": "3363ee2b-8494-4805-9b0f-4a3a535060c4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7adb0bda-5d49-4959-b9f1-bfb4744bbca0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c76701cb-0a92-4c8c-8215-003cf7a6eb1c",
"_parent_id": "6f04a69d-1d1b-4e1f-9cbb-47037413a099",
"root_parent_id": "1201efc5-9d03-497f-aa18-bd2d67e85d32",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7d239e61-2a48-4966-a65f-6bdcaea7684e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "75317901-29e2-43dc-aec5-0ec9ae2a0c82",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f4e6c9e4-bfa8-48b0-9e7c-0a520bab1ca5",
"_parent_code": "sample string 6",
"sales_organization_id": "220fd47a-a841-45df-9936-c64300424e25",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b617f72b-92fd-4056-b1bc-55130ed87549",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b55f1cc-6915-4df9-a887-e27e3e42d6f6",
"db_currency_id": "d8c7eeae-d76b-4b86-b9bd-4a00171614f9",
"db_language_id": "3f47a7e1-7d83-4ef8-8639-adacb813a689",
"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-10T21:25:21.9524048+00:00"
},
"modified_dateutc": "2026-01-10T21:25:21.9524048+00:00"
},
"equipment_model_id": "f252dbb8-4e84-488f-8897-ec7ba4fca5ac",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bf6422ba-2386-4899-8579-2057bc80d787",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "26647113-d3d2-4129-86ac-ebfb2c0befee",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "88b105f4-db6c-44c4-9ef3-dbbc406aaf5d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c4440b36-29c6-4c6d-afd9-bb2c1035c4ff",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b617f72b-92fd-4056-b1bc-55130ed87549",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b55f1cc-6915-4df9-a887-e27e3e42d6f6",
"db_currency_id": "d8c7eeae-d76b-4b86-b9bd-4a00171614f9",
"db_language_id": "3f47a7e1-7d83-4ef8-8639-adacb813a689",
"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-10T21:25:21.9524048+00:00"
},
"modified_dateutc": "2026-01-10T21:25:21.9524048+00:00"
},
"equipment_family_id": "57a12440-ba33-4461-80e8-d68f090dc0b3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "75317901-29e2-43dc-aec5-0ec9ae2a0c82",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f4e6c9e4-bfa8-48b0-9e7c-0a520bab1ca5",
"_parent_code": "sample string 6",
"sales_organization_id": "220fd47a-a841-45df-9936-c64300424e25",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b617f72b-92fd-4056-b1bc-55130ed87549",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b55f1cc-6915-4df9-a887-e27e3e42d6f6",
"db_currency_id": "d8c7eeae-d76b-4b86-b9bd-4a00171614f9",
"db_language_id": "3f47a7e1-7d83-4ef8-8639-adacb813a689",
"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-10T21:25:21.9524048+00:00"
},
"modified_dateutc": "2026-01-10T21:25:21.9524048+00:00"
},
"date_in_production_since": "2026-01-10T21:25:21.9524048+00:00",
"date_out_of_production_since": "2026-01-10T21:25:21.9524048+00:00",
"date_end_support": "2026-01-10T21:25:21.9524048+00:00",
"sales_organization_id": "48924f7a-0a46-41c9-958b-09e4449bf8a3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b617f72b-92fd-4056-b1bc-55130ed87549",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b55f1cc-6915-4df9-a887-e27e3e42d6f6",
"db_currency_id": "d8c7eeae-d76b-4b86-b9bd-4a00171614f9",
"db_language_id": "3f47a7e1-7d83-4ef8-8639-adacb813a689",
"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-10T21:25:21.9524048+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-10T21:25:21.9524048+00:00"
},
"project_status_id": "2aa5117b-e0fd-4a95-93bf-8a9d759f5e24",
"project_status_code": "sample string 10",
"project_status": {
"id": "4292aeb7-7d02-4241-8d9d-75a2027125bb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b742c67e-e65e-4754-8b82-caa4a3c7d747",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b617f72b-92fd-4056-b1bc-55130ed87549",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b55f1cc-6915-4df9-a887-e27e3e42d6f6",
"db_currency_id": "d8c7eeae-d76b-4b86-b9bd-4a00171614f9",
"db_language_id": "3f47a7e1-7d83-4ef8-8639-adacb813a689",
"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-10T21:25:21.9524048+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-10T21:25:21.9524048+00:00"
},
"company_id": "d489662c-b074-41f1-946d-72a23c08b96e",
"company_code": "sample string 12",
"db_address_id": "dd1f22a6-e248-46b0-9ef5-7c3fb182e364",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8ca9f7bb-0a13-4e1a-b84d-5dfcc06180ea",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ab5c89dc-7a58-4845-841e-3ef19c9e9de1",
"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-10T21:25:21.9524048+00:00",
"date_create": "2026-01-10T21:25:21.9524048+00:00",
"date_update": "2026-01-10T21:25:21.9524048+00:00",
"updated_by_user_id": "0eb44582-a832-46e2-bb33-7ed01e437500",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-10T21:25:21.9680566+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-10T21:25:21.9680566+00:00",
"date_last_job": "2026-01-10T21:25:21.9680566+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-10T21:25:21.9680566+00:00",
"modified_dateutc": "2026-01-10T21:25:21.9680566+00:00",
"is_mobile_installation": true
},
"job_type_id": "a7bd0197-0bd0-45d8-8eb9-277d56b54784",
"job_type_code": "sample string 7",
"job_type": {
"id": "16c39d23-e963-4a54-9b10-e919e76ac8cf",
"name": "sample string 2",
"sales_organization_id": "b9df2a12-0357-4ab3-813b-060462fa2b6b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-10T21:25:21.9680566+00:00",
"code": "sample string 7"
},
"job_priority_id": "2dc69aec-ac58-4085-aa68-1b178d373b06",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0c8c2b62-b572-4615-a1e2-ecda429495df",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f3f895d5-5fa0-4e07-be26-691e113eb1bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b617f72b-92fd-4056-b1bc-55130ed87549",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b55f1cc-6915-4df9-a887-e27e3e42d6f6",
"db_currency_id": "d8c7eeae-d76b-4b86-b9bd-4a00171614f9",
"db_language_id": "3f47a7e1-7d83-4ef8-8639-adacb813a689",
"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-10T21:25:21.9524048+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-10T21:25:21.9680566+00:00"
},
"job_status_id": "083d814e-e22b-4aae-938d-69f94a325bdf",
"job_status_code": "sample string 11",
"db_address_id": "39acce57-08bf-45ed-899a-227554843994",
"contact_id": "4652d522-21cf-4685-89dc-22d53467bbfb",
"requested_by_company_id": "70499e90-2c88-4e4f-94d9-b903c4080b20",
"requested_by_contact_id": "73084a30-710e-4388-9349-ee715be557c6",
"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-10T21:25:21.9680566+00:00",
"due_date": "2026-01-10T21:25:21.9680566+00:00",
"date_create": "2026-01-10T21:25:21.9680566+00:00",
"date_update": "2026-01-10T21:25:21.9680566+00:00",
"date_closed": "2026-01-10T21:25:21.9680566+00:00",
"suggested_user_id": "a01815f7-a882-4638-9d4f-14e22062b36d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "eb94dfea-4eb5-4816-b213-e34c14a1230e",
"db_language_id": "4ecbcc09-0414-448a-a804-1b3e20354430",
"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-10T21:25:21.9680566+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7eee94c4-91db-4ff8-8664-0e8002ee2e9f",
"sales_organization": {
"id": "b617f72b-92fd-4056-b1bc-55130ed87549",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b55f1cc-6915-4df9-a887-e27e3e42d6f6",
"db_currency_id": "d8c7eeae-d76b-4b86-b9bd-4a00171614f9",
"db_language_id": "3f47a7e1-7d83-4ef8-8639-adacb813a689",
"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-10T21:25:21.9524048+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "138573b5-14be-4a31-a42d-c3c289b83369",
"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": "f3e0677a-6c1c-48c1-b017-5906bc53bea3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-10T21:25:21.9680566+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1cedd8c9-9c7b-44b5-8574-0bc7e83790c0"
},
"suggested_date_start": "2026-01-10T21:25:21.9680566+00:00",
"skill_id": "5de8caab-1e88-48a3-a753-48721f9b4b8f",
"skill_code": "sample string 32",
"skill": {
"id": "28c2d62c-9dbf-4fac-8d3e-5ae27474c5e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "610e20f6-1876-42e2-a994-bdd0c31ce7b5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b617f72b-92fd-4056-b1bc-55130ed87549",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b55f1cc-6915-4df9-a887-e27e3e42d6f6",
"db_currency_id": "d8c7eeae-d76b-4b86-b9bd-4a00171614f9",
"db_language_id": "3f47a7e1-7d83-4ef8-8639-adacb813a689",
"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-10T21:25:21.9524048+00:00"
},
"modified_dateutc": "2026-01-10T21:25:21.9680566+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1ceca2ce-bf23-42b5-9e11-eb261a7ad2b7",
"date_reported_by_company": "2026-01-10T21:25:21.9680566+00:00",
"id2": 36,
"company_id": "2d9702fb-bdf0-42dc-b062-2841559d7031",
"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": "d6a6e09d-77cf-478e-b045-85f9543ed4f5",
"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-10T21:25:21.9680566+00:00"
},
"work_instruction_details_id": "a43c68d4-2d28-4830-9f65-7dab65672c96",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "42a3fad3-77ee-4114-8682-f1920cb47f47",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9b7aba33-4b35-4987-9faa-7a47585b5ebd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-10T21:25:21.9680566+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": "28fc703c-1806-4aad-b9b2-de555f101ca6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-10T21:25:21.9680566+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.