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": "a3d936cb-2cc6-48bb-943e-951e4227f3fa",
"jobs_id": "b9ccd7cf-f781-4708-8c17-be31cc90c2fd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ee9d2437-5ed7-4e15-9690-56a7b1f778e1",
"_parent_id": "1327b4dc-f8e7-4022-9a4f-366a98e65034",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5e331682-b268-4b5f-8b9b-42a8b6404e8c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "31dfe88c-8f7b-45da-9144-fba1e65fc652",
"_parent_id": "55a38cc4-e0dc-465e-82d2-8cbedc87ddd4",
"root_parent_id": "2c643ff9-164f-4b43-a818-b6a7dbfbc2c8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "28fa6525-724d-4f83-bcdc-3214754e3653",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bf43537a-a132-419e-aaec-b724848f1aea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "771edebc-ee37-4b43-8f63-8441d984aaeb",
"_parent_code": "sample string 6",
"sales_organization_id": "8b6eec18-0d91-49dc-9276-a673818848b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fbf3caa7-2f1d-4fa5-8d94-dabea41a0dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b4b8b84-9049-4f69-9549-d72323fa7eef",
"db_currency_id": "21a5ae0c-99cc-4c93-8b2c-47d339c9538c",
"db_language_id": "f89cbff5-f81d-4011-bef9-b61fb3bf0cf8",
"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-09-03T21:44:41.8819054+00:00"
},
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00"
},
"equipment_model_id": "5c089660-be42-41f1-82b7-c01204917bc2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "87feb692-da04-42d3-ab68-fc768d5357ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3a41c1b1-6a83-4ed3-9681-c5625e3b6adb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3ee83353-38fd-44a1-946a-29c1daaac854",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a5fe037f-df32-4c38-8056-fdf1c120116d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fbf3caa7-2f1d-4fa5-8d94-dabea41a0dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b4b8b84-9049-4f69-9549-d72323fa7eef",
"db_currency_id": "21a5ae0c-99cc-4c93-8b2c-47d339c9538c",
"db_language_id": "f89cbff5-f81d-4011-bef9-b61fb3bf0cf8",
"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-09-03T21:44:41.8819054+00:00"
},
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00"
},
"equipment_family_id": "de18cbc5-6071-476b-a5a6-3fd88338bc17",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bf43537a-a132-419e-aaec-b724848f1aea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "771edebc-ee37-4b43-8f63-8441d984aaeb",
"_parent_code": "sample string 6",
"sales_organization_id": "8b6eec18-0d91-49dc-9276-a673818848b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fbf3caa7-2f1d-4fa5-8d94-dabea41a0dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b4b8b84-9049-4f69-9549-d72323fa7eef",
"db_currency_id": "21a5ae0c-99cc-4c93-8b2c-47d339c9538c",
"db_language_id": "f89cbff5-f81d-4011-bef9-b61fb3bf0cf8",
"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-09-03T21:44:41.8819054+00:00"
},
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00"
},
"date_in_production_since": "2026-09-03T21:44:41.8819054+00:00",
"date_out_of_production_since": "2026-09-03T21:44:41.8819054+00:00",
"date_end_support": "2026-09-03T21:44:41.8819054+00:00",
"sales_organization_id": "7f4bcf7f-b55f-458a-a885-b86d624db93f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fbf3caa7-2f1d-4fa5-8d94-dabea41a0dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b4b8b84-9049-4f69-9549-d72323fa7eef",
"db_currency_id": "21a5ae0c-99cc-4c93-8b2c-47d339c9538c",
"db_language_id": "f89cbff5-f81d-4011-bef9-b61fb3bf0cf8",
"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-09-03T21:44:41.8819054+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-09-03T21:44:41.8819054+00:00"
},
"project_status_id": "83f3566f-f7b4-41a7-96f9-9902c6c0ab9f",
"project_status_code": "sample string 10",
"project_status": {
"id": "cab2c8cf-478b-4ae5-9f7b-30066705ceb9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "454c1632-dc97-4ede-b873-4b9c0fc0542f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fbf3caa7-2f1d-4fa5-8d94-dabea41a0dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b4b8b84-9049-4f69-9549-d72323fa7eef",
"db_currency_id": "21a5ae0c-99cc-4c93-8b2c-47d339c9538c",
"db_language_id": "f89cbff5-f81d-4011-bef9-b61fb3bf0cf8",
"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-09-03T21:44:41.8819054+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00"
},
"company_id": "2f694550-2adb-4f1b-8423-15aac9c52da0",
"company_code": "sample string 12",
"db_address_id": "c11f448c-ede1-4cb9-ad6b-f3a41584d175",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2976e035-23fe-476e-b7ec-7158d0615d32",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4d6ba262-8c45-4640-8d0e-d39a10f03434",
"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-09-03T21:44:41.8819054+00:00",
"date_create": "2026-09-03T21:44:41.8819054+00:00",
"date_update": "2026-09-03T21:44:41.8819054+00:00",
"updated_by_user_id": "27d2ee3c-de46-4134-807c-ff483b206705",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-03T21:44:41.8819054+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-09-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-03T21:44:41.8819054+00:00",
"date_last_job": "2026-09-03T21:44:41.8819054+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-03T21:44:41.8819054+00:00",
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00",
"is_mobile_installation": true
},
"job_type_id": "87bb44d5-9615-4668-97b4-433e3aa15ce6",
"job_type_code": "sample string 7",
"job_type": {
"id": "95521fb7-222d-4181-8091-48ec684bbf59",
"name": "sample string 2",
"sales_organization_id": "572ca407-e4f1-4358-a2c4-a06dd8953b90",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00",
"code": "sample string 7"
},
"job_priority_id": "db16dde0-50d3-40da-8e1e-40a7d10723e1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a6e53bf0-b656-4074-a5bd-4c29f673f778",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "814a3754-8c73-497f-ab88-b0568f2bd064",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fbf3caa7-2f1d-4fa5-8d94-dabea41a0dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b4b8b84-9049-4f69-9549-d72323fa7eef",
"db_currency_id": "21a5ae0c-99cc-4c93-8b2c-47d339c9538c",
"db_language_id": "f89cbff5-f81d-4011-bef9-b61fb3bf0cf8",
"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-09-03T21:44:41.8819054+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00"
},
"job_status_id": "b23380fe-669b-48ca-8cfc-4200c38be4e0",
"job_status_code": "sample string 11",
"db_address_id": "0db507df-5e3f-4e0f-ae63-9c6ba3e9bdc6",
"contact_id": "778266fc-ad62-4bc1-ada6-145d8f82530a",
"requested_by_company_id": "f0fe8d5a-1fce-4987-8c4a-50aa4913f970",
"requested_by_contact_id": "1375f600-eb93-42af-aea1-f68815f0af42",
"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-09-03T21:44:41.8819054+00:00",
"due_date": "2026-09-03T21:44:41.8819054+00:00",
"date_create": "2026-09-03T21:44:41.8819054+00:00",
"date_update": "2026-09-03T21:44:41.8819054+00:00",
"date_closed": "2026-09-03T21:44:41.8819054+00:00",
"suggested_user_id": "a04a966b-7156-4436-80d1-2b6b0331969e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ae9a55e4-5093-42e2-96fe-2913a7f64a62",
"db_language_id": "c62e0112-1aad-498e-b4ed-5e2f1d87c503",
"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-09-03T21:44:41.8819054+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6695a970-8ed3-44ab-b7e7-7f2ffd228f28",
"sales_organization": {
"id": "fbf3caa7-2f1d-4fa5-8d94-dabea41a0dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b4b8b84-9049-4f69-9549-d72323fa7eef",
"db_currency_id": "21a5ae0c-99cc-4c93-8b2c-47d339c9538c",
"db_language_id": "f89cbff5-f81d-4011-bef9-b61fb3bf0cf8",
"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-09-03T21:44:41.8819054+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b68ed76d-2f1f-4324-98d6-24bcd2f76554",
"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": "15a8e5c5-bdcf-423a-b1b6-2e12ba0706c8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e2857148-c3e2-44f9-a920-0d5c4ec8e8c6"
},
"suggested_date_start": "2026-09-03T21:44:41.8819054+00:00",
"skill_id": "859c73ec-95de-436a-9daf-ed70ddccf3d4",
"skill_code": "sample string 32",
"skill": {
"id": "acf7b56e-e67d-46aa-9a2f-9ceedca66146",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5dc43b48-278b-45d2-8d55-1ff47c7096bb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fbf3caa7-2f1d-4fa5-8d94-dabea41a0dd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b4b8b84-9049-4f69-9549-d72323fa7eef",
"db_currency_id": "21a5ae0c-99cc-4c93-8b2c-47d339c9538c",
"db_language_id": "f89cbff5-f81d-4011-bef9-b61fb3bf0cf8",
"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-09-03T21:44:41.8819054+00:00"
},
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4a5759a0-9d01-4fb7-af3f-421139b37b92",
"date_reported_by_company": "2026-09-03T21:44:41.8819054+00:00",
"id2": 36,
"company_id": "27f03708-6654-455d-9ac7-8b3529534f04",
"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": "b3807725-4a1e-454f-a1d4-69cdc5c27a0c",
"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-09-03T21:44:41.8819054+00:00"
},
"work_instruction_details_id": "148589f1-cd84-4340-be67-96046b3ee403",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9ec1b2a0-f15d-4a21-8ba2-c421ffe3b462",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fffa317c-380c-4af1-bb18-2e24aaae7846",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-03T21:44:41.8819054+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": "8d46068a-4375-4f4f-90bc-4778f902af01",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-03T21:44:41.8819054+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.