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": "fe28c8eb-46ee-4c33-9f57-ce1c87302e48",
"jobs_id": "40b050cd-0b3e-49a0-b1df-145d2102e031",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5dde9072-809a-42d1-8655-d90826c44284",
"_parent_id": "37d7383e-e32f-4453-ae2f-bfd9b70ad546",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1d160c63-a1ab-4c59-83d8-ceb8a1985347",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4ee9a853-4cd2-45d4-abfd-770255736374",
"_parent_id": "ddacb433-fb3c-4fc0-b9eb-e998582ae98e",
"root_parent_id": "c0debfdc-9042-4ac8-ba04-87ce11de3b34",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "64231533-4d11-4e68-95a6-4202d05fe2ee",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9f49d979-0531-4e2f-84f6-2b64155bc2c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7380cf4f-57a0-42a3-beb9-e94d64f4b698",
"_parent_code": "sample string 6",
"sales_organization_id": "3307fb84-a969-44c3-ab66-90721bb96e97",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb120061-74bb-4c2e-860c-d8b90e2c206d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d225641a-2e2b-496a-bedd-39f1b5541f36",
"db_currency_id": "a22c649c-e6f0-4857-9d4b-04714f32d3ee",
"db_language_id": "7c72a92a-a113-4ef0-a989-61a269c9d76c",
"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-02-21T02:03:40.452807+00:00"
},
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00"
},
"equipment_model_id": "4ec38f05-d50a-41dc-928a-1d4516eb141b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c4095f3c-205c-4af5-be8a-8df273517387",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "27476560-dc89-43b6-9e7d-b525a858b664",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "99a5a104-9623-41f0-a24e-06b557110979",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "12bf370b-395f-4cfa-b180-c7fbb671f8c2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb120061-74bb-4c2e-860c-d8b90e2c206d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d225641a-2e2b-496a-bedd-39f1b5541f36",
"db_currency_id": "a22c649c-e6f0-4857-9d4b-04714f32d3ee",
"db_language_id": "7c72a92a-a113-4ef0-a989-61a269c9d76c",
"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-02-21T02:03:40.452807+00:00"
},
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00"
},
"equipment_family_id": "a37f3429-085f-4ee0-b80f-75e60b14d0ec",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9f49d979-0531-4e2f-84f6-2b64155bc2c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7380cf4f-57a0-42a3-beb9-e94d64f4b698",
"_parent_code": "sample string 6",
"sales_organization_id": "3307fb84-a969-44c3-ab66-90721bb96e97",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb120061-74bb-4c2e-860c-d8b90e2c206d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d225641a-2e2b-496a-bedd-39f1b5541f36",
"db_currency_id": "a22c649c-e6f0-4857-9d4b-04714f32d3ee",
"db_language_id": "7c72a92a-a113-4ef0-a989-61a269c9d76c",
"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-02-21T02:03:40.452807+00:00"
},
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00"
},
"date_in_production_since": "2026-02-21T02:03:40.452807+00:00",
"date_out_of_production_since": "2026-02-21T02:03:40.452807+00:00",
"date_end_support": "2026-02-21T02:03:40.452807+00:00",
"sales_organization_id": "a184fdff-d96c-4f06-83d5-458d78d6c038",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eb120061-74bb-4c2e-860c-d8b90e2c206d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d225641a-2e2b-496a-bedd-39f1b5541f36",
"db_currency_id": "a22c649c-e6f0-4857-9d4b-04714f32d3ee",
"db_language_id": "7c72a92a-a113-4ef0-a989-61a269c9d76c",
"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-02-21T02:03:40.452807+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-02-21T02:03:40.452807+00:00"
},
"project_status_id": "fe233729-8b4c-4a6f-9f69-ebcb89005dd2",
"project_status_code": "sample string 10",
"project_status": {
"id": "387b9a8d-bbb7-4bd5-9267-355f0424e4e9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "54bd8d8e-1e1a-4a09-a49f-d7cdb957bea6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb120061-74bb-4c2e-860c-d8b90e2c206d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d225641a-2e2b-496a-bedd-39f1b5541f36",
"db_currency_id": "a22c649c-e6f0-4857-9d4b-04714f32d3ee",
"db_language_id": "7c72a92a-a113-4ef0-a989-61a269c9d76c",
"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-02-21T02:03:40.452807+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00"
},
"company_id": "5471d145-fbce-4e2c-b07e-9a624a916374",
"company_code": "sample string 12",
"db_address_id": "058e3a4d-2930-4f05-8837-fb6a9aded894",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cf304cad-6d15-479c-8076-789154224ae8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "104f8393-ed21-4e84-976d-5346fed1afd7",
"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-02-21T02:03:40.452807+00:00",
"date_create": "2026-02-21T02:03:40.452807+00:00",
"date_update": "2026-02-21T02:03:40.452807+00:00",
"updated_by_user_id": "1bd8c360-03fd-4e43-9bf4-ff754eb8588d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-21T02:03:40.452807+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-02-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-21T02:03:40.452807+00:00",
"date_last_job": "2026-02-21T02:03:40.452807+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-21T02:03:40.452807+00:00",
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00",
"is_mobile_installation": true
},
"job_type_id": "286ddaf7-13d6-4457-9885-daa27947eefa",
"job_type_code": "sample string 7",
"job_type": {
"id": "0c54f47c-b32c-42d9-b371-dba29244ceb7",
"name": "sample string 2",
"sales_organization_id": "448e019c-e55d-4ed0-b3fe-86ddd9434be4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00",
"code": "sample string 7"
},
"job_priority_id": "7d535709-f5a1-4215-a1e5-47d8ecbe9c1f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9684a3ba-696d-4280-823a-b8988fbe71f9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "84e8472e-50b6-4e72-bef4-fdffe944ffae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb120061-74bb-4c2e-860c-d8b90e2c206d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d225641a-2e2b-496a-bedd-39f1b5541f36",
"db_currency_id": "a22c649c-e6f0-4857-9d4b-04714f32d3ee",
"db_language_id": "7c72a92a-a113-4ef0-a989-61a269c9d76c",
"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-02-21T02:03:40.452807+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00"
},
"job_status_id": "5ca01ef5-b594-4def-9874-6b0f76a997c2",
"job_status_code": "sample string 11",
"db_address_id": "8b6837a2-3317-4013-9741-c199fc00b492",
"contact_id": "5ceaea43-ee2d-44b6-9b46-81f635d5338b",
"requested_by_company_id": "948db987-3e51-4566-a297-68f760f07881",
"requested_by_contact_id": "71ba2c58-9322-4d18-aa56-eeab3b1f16f5",
"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-02-21T02:03:40.452807+00:00",
"due_date": "2026-02-21T02:03:40.452807+00:00",
"date_create": "2026-02-21T02:03:40.452807+00:00",
"date_update": "2026-02-21T02:03:40.452807+00:00",
"date_closed": "2026-02-21T02:03:40.452807+00:00",
"suggested_user_id": "192b47e3-fbd2-4d74-91e5-62313f86238b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "53e8fe0e-688b-46e5-8e31-95fc3cf2f077",
"db_language_id": "f7ab75fd-c427-4768-843f-54e65a7bdf6e",
"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-02-21T02:03:40.452807+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "20942b91-c2c5-4eef-b6f8-49e24e848189",
"sales_organization": {
"id": "eb120061-74bb-4c2e-860c-d8b90e2c206d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d225641a-2e2b-496a-bedd-39f1b5541f36",
"db_currency_id": "a22c649c-e6f0-4857-9d4b-04714f32d3ee",
"db_language_id": "7c72a92a-a113-4ef0-a989-61a269c9d76c",
"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-02-21T02:03:40.452807+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "81df3c5a-79d5-420f-a5a6-7eb84a39a00a",
"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": "15903de1-6009-4249-9d50-880533a011f8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "44853720-1345-40b4-aa29-14c21d690b19"
},
"suggested_date_start": "2026-02-21T02:03:40.452807+00:00",
"skill_id": "90a9f22d-2bf4-4266-a41c-6e9f563628cd",
"skill_code": "sample string 32",
"skill": {
"id": "356073cc-86c8-4116-be10-8b3e7ddee57b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8baf58e8-b16e-428b-90d7-34759de29b68",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb120061-74bb-4c2e-860c-d8b90e2c206d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d225641a-2e2b-496a-bedd-39f1b5541f36",
"db_currency_id": "a22c649c-e6f0-4857-9d4b-04714f32d3ee",
"db_language_id": "7c72a92a-a113-4ef0-a989-61a269c9d76c",
"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-02-21T02:03:40.452807+00:00"
},
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "02c8b489-da67-4c8b-af8a-9e28fdaaac6d",
"date_reported_by_company": "2026-02-21T02:03:40.452807+00:00",
"id2": 36,
"company_id": "b474a088-fa2c-45ae-b629-48c4b04e7fdb",
"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": "e96d86ed-dead-4f55-b25e-474c206d99bd",
"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-02-21T02:03:40.452807+00:00"
},
"work_instruction_details_id": "8e286f79-1415-4b29-a7c2-4b1aabb78040",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fdb24bda-2893-4b44-9be6-9a7849cd3162",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "03c15914-6f7d-4880-b85a-e803958a76f4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-21T02:03:40.452807+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": "980eda95-532f-4b85-af32-817acc91887e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-21T02:03:40.452807+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.