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": "5edba1e8-a36c-405d-8bd7-a1db36f37f2d",
"jobs_id": "1b8bfa89-94ef-4477-bed0-6be8a6778947",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a9edc0b9-954f-4ae7-8510-d8efa68cba8b",
"_parent_id": "0bad4a4b-1b3c-43f4-8732-45f419e65ec8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9912f773-913d-4511-b1b8-bd7fe8d33e9e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0f7f22bd-6e91-4fda-abf7-0d2441182dd3",
"_parent_id": "6e5ce223-7525-476a-8078-a3352fdfb04d",
"root_parent_id": "18581819-44d7-44d2-aea0-7e7b2b028279",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ae24d701-bef9-42a3-bcba-39e2378c23d6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1223a8b6-25d4-4ee0-aadf-5be6a48da709",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ba8f260-e0ef-41c2-aafa-e0e8fde9078e",
"_parent_code": "sample string 6",
"sales_organization_id": "9d01facf-fb4e-46bb-863e-9e8a48ffadb3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "82177852-d93f-4db2-8e3b-285e5e1b415e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213aec22-4feb-4bcb-8cfc-e5d74aa49fb8",
"db_currency_id": "92bc8249-77f4-41cd-a0c7-84bb99abee46",
"db_language_id": "4135661c-81c7-4892-b000-5b5719789243",
"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-06T10:33:46.8677655+00:00"
},
"modified_dateutc": "2026-10-06T10:33:46.8677655+00:00"
},
"equipment_model_id": "9dbe42a1-5086-4b3a-8bb7-c8d5c9d9fcfb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4abfca5a-b56f-47f2-889c-261b891e64e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "46205fd2-2dac-4f32-80d4-88a05516c0b2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "667663cd-ad61-4223-801f-990b48e6f8f9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a0ff5972-6641-4ea4-a3fd-61f9908845f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "82177852-d93f-4db2-8e3b-285e5e1b415e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213aec22-4feb-4bcb-8cfc-e5d74aa49fb8",
"db_currency_id": "92bc8249-77f4-41cd-a0c7-84bb99abee46",
"db_language_id": "4135661c-81c7-4892-b000-5b5719789243",
"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-06T10:33:46.8677655+00:00"
},
"modified_dateutc": "2026-10-06T10:33:46.8677655+00:00"
},
"equipment_family_id": "1b5c509b-3efd-403d-8459-a0f31728404a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1223a8b6-25d4-4ee0-aadf-5be6a48da709",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ba8f260-e0ef-41c2-aafa-e0e8fde9078e",
"_parent_code": "sample string 6",
"sales_organization_id": "9d01facf-fb4e-46bb-863e-9e8a48ffadb3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "82177852-d93f-4db2-8e3b-285e5e1b415e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213aec22-4feb-4bcb-8cfc-e5d74aa49fb8",
"db_currency_id": "92bc8249-77f4-41cd-a0c7-84bb99abee46",
"db_language_id": "4135661c-81c7-4892-b000-5b5719789243",
"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-06T10:33:46.8677655+00:00"
},
"modified_dateutc": "2026-10-06T10:33:46.8677655+00:00"
},
"date_in_production_since": "2026-10-06T10:33:46.8677655+00:00",
"date_out_of_production_since": "2026-10-06T10:33:46.8677655+00:00",
"date_end_support": "2026-10-06T10:33:46.8677655+00:00",
"sales_organization_id": "ad310e3f-dba8-4a92-997b-6ae8a5399e02",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "82177852-d93f-4db2-8e3b-285e5e1b415e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213aec22-4feb-4bcb-8cfc-e5d74aa49fb8",
"db_currency_id": "92bc8249-77f4-41cd-a0c7-84bb99abee46",
"db_language_id": "4135661c-81c7-4892-b000-5b5719789243",
"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-06T10:33:46.8677655+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-06T10:33:46.8677655+00:00"
},
"project_status_id": "a9eeb59d-26b4-4303-8fae-6c94de3314bc",
"project_status_code": "sample string 10",
"project_status": {
"id": "7326c9bf-626c-48c7-b37b-daa72cdd6859",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8e4be2bc-9d47-4625-af02-2709f045221a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "82177852-d93f-4db2-8e3b-285e5e1b415e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213aec22-4feb-4bcb-8cfc-e5d74aa49fb8",
"db_currency_id": "92bc8249-77f4-41cd-a0c7-84bb99abee46",
"db_language_id": "4135661c-81c7-4892-b000-5b5719789243",
"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-06T10:33:46.8677655+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T10:33:46.8677655+00:00"
},
"company_id": "c7ee0889-6b17-4f31-af06-c3dd1162d077",
"company_code": "sample string 12",
"db_address_id": "18606665-0963-40db-98a6-0a53f36fd769",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "031614c4-d94b-4bf4-b44e-9b8b71e4f42e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "834263e6-e948-44f1-ac5b-31b7af67023a",
"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-06T10:33:46.8833906+00:00",
"date_create": "2026-10-06T10:33:46.8833906+00:00",
"date_update": "2026-10-06T10:33:46.8833906+00:00",
"updated_by_user_id": "64ac4ea4-c68c-43b6-be9d-272efd144bac",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-06T10:33:46.8833906+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-06T10:33:46.8833906+00:00",
"date_last_job": "2026-10-06T10:33:46.8833906+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-06T10:33:46.8833906+00:00",
"modified_dateutc": "2026-10-06T10:33:46.8833906+00:00",
"is_mobile_installation": true
},
"job_type_id": "9b36ae92-c3bb-4fb6-a94f-5433f86bcdf9",
"job_type_code": "sample string 7",
"job_type": {
"id": "975eaa8b-63a8-4d87-b7c1-a79ccdaf75a0",
"name": "sample string 2",
"sales_organization_id": "39ebe482-65be-4583-8d99-c88038ef86d6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-06T10:33:46.8833906+00:00",
"code": "sample string 7"
},
"job_priority_id": "7bbbb094-f71f-4a5a-bf9d-b25426032705",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "333c0257-28e1-48ee-b6d7-8cb605adee01",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9e411e67-c62f-407e-858c-4e833317c70e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "82177852-d93f-4db2-8e3b-285e5e1b415e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213aec22-4feb-4bcb-8cfc-e5d74aa49fb8",
"db_currency_id": "92bc8249-77f4-41cd-a0c7-84bb99abee46",
"db_language_id": "4135661c-81c7-4892-b000-5b5719789243",
"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-06T10:33:46.8677655+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T10:33:46.8833906+00:00"
},
"job_status_id": "e6e4b10f-42d8-4f70-89cb-cf2eafb01bb5",
"job_status_code": "sample string 11",
"db_address_id": "2cc5c722-dde2-48de-bcba-79299113c789",
"contact_id": "630bbf03-5671-4fff-b074-33a95f14d2ce",
"requested_by_company_id": "f2d8fb83-e405-47f7-8d78-2d6ec8ec7861",
"requested_by_contact_id": "abcbd658-71e1-4f41-9506-830df559bc58",
"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-06T10:33:46.8833906+00:00",
"due_date": "2026-10-06T10:33:46.8833906+00:00",
"date_create": "2026-10-06T10:33:46.8833906+00:00",
"date_update": "2026-10-06T10:33:46.8833906+00:00",
"date_closed": "2026-10-06T10:33:46.8833906+00:00",
"suggested_user_id": "0b7ec1bb-50f4-4fa7-b7ac-413d81d91478",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b8aa0d84-291a-4631-84a8-f429564260c9",
"db_language_id": "e2861fde-f4f0-4c60-89a4-c0748d90ca66",
"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-06T10:33:46.8833906+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "440a6175-3ab1-4629-a208-dcd667a8690c",
"sales_organization": {
"id": "82177852-d93f-4db2-8e3b-285e5e1b415e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213aec22-4feb-4bcb-8cfc-e5d74aa49fb8",
"db_currency_id": "92bc8249-77f4-41cd-a0c7-84bb99abee46",
"db_language_id": "4135661c-81c7-4892-b000-5b5719789243",
"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-06T10:33:46.8677655+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "25afd7fe-f8b8-479f-a530-4786b281c433",
"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": "f97c2a5e-0ad8-4492-8fdb-60a96a7234b9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-06T10:33:46.8833906+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2e1f1c67-cb10-4dde-9c04-501ccf875be8"
},
"suggested_date_start": "2026-10-06T10:33:46.8833906+00:00",
"skill_id": "4ad056ef-ce64-4f9f-998b-be63431e99c5",
"skill_code": "sample string 32",
"skill": {
"id": "93db285c-9dc3-469b-ad1a-c37638d35340",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "77c8b63f-e852-4027-977f-e36c6fa83328",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "82177852-d93f-4db2-8e3b-285e5e1b415e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "213aec22-4feb-4bcb-8cfc-e5d74aa49fb8",
"db_currency_id": "92bc8249-77f4-41cd-a0c7-84bb99abee46",
"db_language_id": "4135661c-81c7-4892-b000-5b5719789243",
"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-06T10:33:46.8677655+00:00"
},
"modified_dateutc": "2026-10-06T10:33:46.8833906+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fe2acb6a-c8f4-425b-82f2-4a14f557b109",
"date_reported_by_company": "2026-10-06T10:33:46.8833906+00:00",
"id2": 36,
"company_id": "6c57df5e-237e-4c2d-8b9d-7057b0ee555a",
"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": "250fb0a9-3b15-4f95-b2a7-25fa9f9eedd5",
"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-06T10:33:46.8833906+00:00"
},
"work_instruction_details_id": "538bd352-0d9f-454e-b1e5-a59372fd9c4c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f1d8c063-c253-4fd7-bbf4-2309e9c4c835",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "071df469-c86b-4f0f-9953-7bf10258faf7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-06T10:33:46.8833906+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": "3a7dbcdd-5bfa-43e1-bcec-03e6f85057d5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-06T10:33:46.8833906+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.