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": "c2ecf7d8-b9b4-4fec-a88b-7cea8dc9dc3b",
"jobs_id": "0bcc7fa5-6a74-4c64-9800-9998cf70c0ef",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0c10f140-24a2-45df-a03c-00fb56d7f424",
"_parent_id": "3eef6bd8-3391-4652-ab65-95e6f61fa938",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "326dfb78-6cf7-428b-90d4-5b00ef0a52c8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f9761988-cb14-46a4-8dcb-1fd1e45eccee",
"_parent_id": "e92f24dd-fb38-44e7-bb3c-34e1cc3cdf73",
"root_parent_id": "d25e06bf-c8c2-492e-afd5-fa09d620d9bb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "38dcf4fb-1ecb-4a01-a8f3-f077a7997b2e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dfada841-9cc8-45a2-a1bc-a79802dae822",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab17897a-c2d0-43c9-8d47-6b01ca523a03",
"_parent_code": "sample string 6",
"sales_organization_id": "257aa74e-4ec0-458b-9a43-23fee6e4a124",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf6f00b6-1d13-4bed-9d28-86c8e4d10695",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dafbc8c6-582a-483b-af54-47310c3796d8",
"db_currency_id": "ea484f95-27b4-4d80-ae10-d992d6b5ce65",
"db_language_id": "b803d814-6c32-44dc-8245-aba15127771c",
"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-10-16T09:07:02.5832129+00:00"
},
"modified_dateutc": "2026-10-16T09:07:02.5832129+00:00"
},
"equipment_model_id": "5c86f1c4-553d-4345-bb33-25c8b08b020b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fe8472e9-972b-46fb-9458-82be51bffae3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "76d00f99-3bc3-4877-b9ad-36850f42c955",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b8c6fd09-f7c3-475d-b684-59884bab245b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "08417e73-e2ac-4c1d-bb83-20c1b23bc710",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cf6f00b6-1d13-4bed-9d28-86c8e4d10695",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dafbc8c6-582a-483b-af54-47310c3796d8",
"db_currency_id": "ea484f95-27b4-4d80-ae10-d992d6b5ce65",
"db_language_id": "b803d814-6c32-44dc-8245-aba15127771c",
"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-10-16T09:07:02.5832129+00:00"
},
"modified_dateutc": "2026-10-16T09:07:02.5832129+00:00"
},
"equipment_family_id": "32d78a07-cdca-4154-b1a7-b18f8a90a279",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dfada841-9cc8-45a2-a1bc-a79802dae822",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab17897a-c2d0-43c9-8d47-6b01ca523a03",
"_parent_code": "sample string 6",
"sales_organization_id": "257aa74e-4ec0-458b-9a43-23fee6e4a124",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf6f00b6-1d13-4bed-9d28-86c8e4d10695",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dafbc8c6-582a-483b-af54-47310c3796d8",
"db_currency_id": "ea484f95-27b4-4d80-ae10-d992d6b5ce65",
"db_language_id": "b803d814-6c32-44dc-8245-aba15127771c",
"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-10-16T09:07:02.5832129+00:00"
},
"modified_dateutc": "2026-10-16T09:07:02.5832129+00:00"
},
"date_in_production_since": "2026-10-16T09:07:02.5832129+00:00",
"date_out_of_production_since": "2026-10-16T09:07:02.5832129+00:00",
"date_end_support": "2026-10-16T09:07:02.5832129+00:00",
"sales_organization_id": "c31f62f0-20c0-4378-b75d-2e27952f6145",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cf6f00b6-1d13-4bed-9d28-86c8e4d10695",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dafbc8c6-582a-483b-af54-47310c3796d8",
"db_currency_id": "ea484f95-27b4-4d80-ae10-d992d6b5ce65",
"db_language_id": "b803d814-6c32-44dc-8245-aba15127771c",
"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-10-16T09:07:02.5832129+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-10-16T09:07:02.5832129+00:00"
},
"project_status_id": "d9cb8988-3ea7-48df-b89c-60672a49ac85",
"project_status_code": "sample string 10",
"project_status": {
"id": "f5ef4800-0b04-47a0-8465-844642da48bb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b09b901b-a6b1-438f-8f8b-f58331d31e65",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf6f00b6-1d13-4bed-9d28-86c8e4d10695",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dafbc8c6-582a-483b-af54-47310c3796d8",
"db_currency_id": "ea484f95-27b4-4d80-ae10-d992d6b5ce65",
"db_language_id": "b803d814-6c32-44dc-8245-aba15127771c",
"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-10-16T09:07:02.5832129+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-16T09:07:02.5832129+00:00"
},
"company_id": "d1310fc7-5d54-4453-89d7-c6d27704a59d",
"company_code": "sample string 12",
"db_address_id": "8defd84a-a152-44fd-8b48-be42c57f7a93",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e57630bb-2103-401a-8555-bcdee09ab466",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "315ce811-b394-4754-8979-332361aee7ac",
"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-10-16T09:07:02.5832129+00:00",
"date_create": "2026-10-16T09:07:02.5832129+00:00",
"date_update": "2026-10-16T09:07:02.5832129+00:00",
"updated_by_user_id": "8ce0a9be-d6da-43fa-8369-d5fdee10dc48",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-16T09:07:02.5832129+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-10-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-16T09:07:02.5832129+00:00",
"date_last_job": "2026-10-16T09:07:02.5832129+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-16T09:07:02.5832129+00:00",
"modified_dateutc": "2026-10-16T09:07:02.5832129+00:00",
"is_mobile_installation": true
},
"job_type_id": "42f972a4-5e34-4607-a200-e15f65149ed9",
"job_type_code": "sample string 7",
"job_type": {
"id": "7d9b0ac8-a3a1-47d8-8f1f-0038e9c579ef",
"name": "sample string 2",
"sales_organization_id": "d64e52d9-998e-4f45-adfe-6d3039cac460",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-16T09:07:02.5832129+00:00",
"code": "sample string 7"
},
"job_priority_id": "165ae83a-d2db-428f-a8e7-72896a61bdee",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a8a44405-5f36-4551-ba42-dbaf6186259e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ccf93412-183e-435f-9b7c-3fcd9bdc967e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf6f00b6-1d13-4bed-9d28-86c8e4d10695",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dafbc8c6-582a-483b-af54-47310c3796d8",
"db_currency_id": "ea484f95-27b4-4d80-ae10-d992d6b5ce65",
"db_language_id": "b803d814-6c32-44dc-8245-aba15127771c",
"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-10-16T09:07:02.5832129+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-16T09:07:02.5832129+00:00"
},
"job_status_id": "48b67802-1aba-4ccc-9bbf-b1c45d51fb6d",
"job_status_code": "sample string 11",
"db_address_id": "c82cb072-2004-40a6-9751-ad7bbda54156",
"contact_id": "0c56607f-4269-4019-8d13-3ee5d31426c9",
"requested_by_company_id": "ba6edc1e-890f-4c52-9dbf-23fed6c52992",
"requested_by_contact_id": "6d2938a5-fb62-413c-8e8d-bdd037d02b50",
"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-10-16T09:07:02.5832129+00:00",
"due_date": "2026-10-16T09:07:02.5832129+00:00",
"date_create": "2026-10-16T09:07:02.5832129+00:00",
"date_update": "2026-10-16T09:07:02.5832129+00:00",
"date_closed": "2026-10-16T09:07:02.5832129+00:00",
"suggested_user_id": "f3d3cc30-f55c-4077-8a39-336c327d27c8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "86918e58-16dc-43b9-ad38-b30f616c19a2",
"db_language_id": "245aba15-dbd7-4c7a-ae36-509552fbadf2",
"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-10-16T09:07:02.5832129+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a135b899-ccd6-41da-ac49-87189eafb877",
"sales_organization": {
"id": "cf6f00b6-1d13-4bed-9d28-86c8e4d10695",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dafbc8c6-582a-483b-af54-47310c3796d8",
"db_currency_id": "ea484f95-27b4-4d80-ae10-d992d6b5ce65",
"db_language_id": "b803d814-6c32-44dc-8245-aba15127771c",
"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-10-16T09:07:02.5832129+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c7d76c89-8c7a-4502-af59-b32351a5776a",
"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": "6924e752-b0ca-44f8-8cfa-5b7149c80a50",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-16T09:07:02.6144472+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1e45ae50-98dc-4832-8ede-6cdad29c8645"
},
"suggested_date_start": "2026-10-16T09:07:02.6144472+00:00",
"skill_id": "9ab41aee-a95c-4f27-88f8-ce4ef8eed559",
"skill_code": "sample string 32",
"skill": {
"id": "d8230d2f-0db3-409a-b338-48f4d3ea5d03",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9fe03515-8527-4c70-84e5-87dab50cda27",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf6f00b6-1d13-4bed-9d28-86c8e4d10695",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dafbc8c6-582a-483b-af54-47310c3796d8",
"db_currency_id": "ea484f95-27b4-4d80-ae10-d992d6b5ce65",
"db_language_id": "b803d814-6c32-44dc-8245-aba15127771c",
"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-10-16T09:07:02.5832129+00:00"
},
"modified_dateutc": "2026-10-16T09:07:02.6144472+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "741e2c0f-5932-45ae-a8cb-3931f9bdeb82",
"date_reported_by_company": "2026-10-16T09:07:02.6144472+00:00",
"id2": 36,
"company_id": "814d9180-ef8c-440c-a8c4-28036de5bf37",
"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": "5707589a-9639-44b6-9ba1-411aa8c30209",
"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-10-16T09:07:02.6144472+00:00"
},
"work_instruction_details_id": "0e6b94eb-db63-4244-83fc-423c25de161f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "578e5a4e-3b0e-4d4b-a15a-000b5893ead7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ce192c01-c32e-43e8-90f0-dc9fc1549781",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-16T09:07:02.6144472+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": "f00c6fa9-c37b-4b92-825e-a5bf4f43cdca",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-16T09:07:02.6144472+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.