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": "bd8f3b37-b9db-477f-b41a-a68395cb1456",
"jobs_id": "f1fa80c0-774c-44b9-b0b3-b8418ad41eb6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e9bb5c77-0c2e-4bce-ada6-877efe7d2a75",
"_parent_id": "34162d5a-10bf-4328-a7e1-87d98b6cec78",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "78392f0f-d388-4178-bac6-5052da1f7b58",
"project_reference_back_office": "sample string 5",
"project": {
"id": "103ee33a-ca89-4ce2-a62b-c7c25d91a798",
"_parent_id": "346508c1-3a31-4458-b365-f47c7e7ed0a7",
"root_parent_id": "796c59ed-cf81-4ec3-b81d-3e73eda9acf6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "17ade386-d6ad-4033-a431-dd48acfa7b68",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7c27eaa6-6aec-44de-afae-73bc5640bcd5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "26fb7bbc-b510-4739-932f-f02822973821",
"_parent_code": "sample string 6",
"sales_organization_id": "7d2d4827-9c2b-480e-82a4-38563b40cd96",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "522a2899-96d8-4a4f-bb75-c5c2eb4f8b39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d31ddc-9ac2-4a84-8ff0-f88824b87219",
"db_currency_id": "2b3ba7f6-9f49-4e1d-9bfa-e2ac3a197b1f",
"db_language_id": "bb9878ad-911c-48ee-9e15-b112f77b8166",
"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-23T02:48:07.3250346+00:00"
},
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00"
},
"equipment_model_id": "f291b387-6929-40ae-b87d-bb1e2cbbd163",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cd9da1bd-e217-4612-8c3f-474128ea33d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7e3a5940-b7f5-4a9c-a884-2ea1e4860e4b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1193a62e-21f5-41c5-8f69-b3dbdcdc94db",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "32a7f72e-abbd-4084-b6c6-58c18c39910f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "522a2899-96d8-4a4f-bb75-c5c2eb4f8b39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d31ddc-9ac2-4a84-8ff0-f88824b87219",
"db_currency_id": "2b3ba7f6-9f49-4e1d-9bfa-e2ac3a197b1f",
"db_language_id": "bb9878ad-911c-48ee-9e15-b112f77b8166",
"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-23T02:48:07.3250346+00:00"
},
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00"
},
"equipment_family_id": "fc9f668a-efbe-4726-a80f-217dfb64d1a9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7c27eaa6-6aec-44de-afae-73bc5640bcd5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "26fb7bbc-b510-4739-932f-f02822973821",
"_parent_code": "sample string 6",
"sales_organization_id": "7d2d4827-9c2b-480e-82a4-38563b40cd96",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "522a2899-96d8-4a4f-bb75-c5c2eb4f8b39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d31ddc-9ac2-4a84-8ff0-f88824b87219",
"db_currency_id": "2b3ba7f6-9f49-4e1d-9bfa-e2ac3a197b1f",
"db_language_id": "bb9878ad-911c-48ee-9e15-b112f77b8166",
"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-23T02:48:07.3250346+00:00"
},
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00"
},
"date_in_production_since": "2026-09-23T02:48:07.3250346+00:00",
"date_out_of_production_since": "2026-09-23T02:48:07.3250346+00:00",
"date_end_support": "2026-09-23T02:48:07.3250346+00:00",
"sales_organization_id": "672162a9-6d88-4974-bbf8-8bc0044943c9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "522a2899-96d8-4a4f-bb75-c5c2eb4f8b39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d31ddc-9ac2-4a84-8ff0-f88824b87219",
"db_currency_id": "2b3ba7f6-9f49-4e1d-9bfa-e2ac3a197b1f",
"db_language_id": "bb9878ad-911c-48ee-9e15-b112f77b8166",
"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-23T02:48:07.3250346+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-23T02:48:07.3250346+00:00"
},
"project_status_id": "d8db8ffb-1a80-409b-b9c9-677158b19632",
"project_status_code": "sample string 10",
"project_status": {
"id": "10699bae-353b-4b0e-b2de-da4a896a767d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c04a9e28-7330-44f9-9643-74883b76642c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "522a2899-96d8-4a4f-bb75-c5c2eb4f8b39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d31ddc-9ac2-4a84-8ff0-f88824b87219",
"db_currency_id": "2b3ba7f6-9f49-4e1d-9bfa-e2ac3a197b1f",
"db_language_id": "bb9878ad-911c-48ee-9e15-b112f77b8166",
"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-23T02:48:07.3250346+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00"
},
"company_id": "7aa0b589-a7a8-45d9-91a7-7b336ba3ffd0",
"company_code": "sample string 12",
"db_address_id": "5fbb16ee-2656-4356-bddc-8369a111bc31",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5547b8fa-ff68-4fed-822f-baabd5a5a1ef",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b98d7fd8-fccb-433f-95ee-4246304475e7",
"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-23T02:48:07.3250346+00:00",
"date_create": "2026-09-23T02:48:07.3250346+00:00",
"date_update": "2026-09-23T02:48:07.3250346+00:00",
"updated_by_user_id": "0dbafa28-63bf-4fcc-9969-6a22ca631b69",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T02:48:07.3250346+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T02:48:07.3250346+00:00",
"date_last_job": "2026-09-23T02:48:07.3250346+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T02:48:07.3250346+00:00",
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00",
"is_mobile_installation": true
},
"job_type_id": "4005c93b-ce25-4eb5-8e44-401297039ef3",
"job_type_code": "sample string 7",
"job_type": {
"id": "7d6b0cff-c086-49ce-941e-56f4a3de4119",
"name": "sample string 2",
"sales_organization_id": "8e08dcd3-59f3-4650-8eaa-9875f91dd876",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00",
"code": "sample string 7"
},
"job_priority_id": "e69af8e3-f97d-4ed6-8726-a2b6221857f5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "91c852f3-ecf0-42fe-844d-53d80ffb2ae5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8628ea63-28fd-4114-8cc8-7cecadbb9c94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "522a2899-96d8-4a4f-bb75-c5c2eb4f8b39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d31ddc-9ac2-4a84-8ff0-f88824b87219",
"db_currency_id": "2b3ba7f6-9f49-4e1d-9bfa-e2ac3a197b1f",
"db_language_id": "bb9878ad-911c-48ee-9e15-b112f77b8166",
"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-23T02:48:07.3250346+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00"
},
"job_status_id": "7028799c-17b1-4e05-b96a-0ac353e07f79",
"job_status_code": "sample string 11",
"db_address_id": "5d2db84c-cbc1-431b-a887-11edcaea2d35",
"contact_id": "1df70360-ad38-4367-86fa-be65318deb51",
"requested_by_company_id": "8497ec7e-ebe4-430b-9e1a-d174110c4198",
"requested_by_contact_id": "ec23897b-540d-4412-8e0a-5b0de5fa6d7b",
"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-23T02:48:07.3250346+00:00",
"due_date": "2026-09-23T02:48:07.3250346+00:00",
"date_create": "2026-09-23T02:48:07.3250346+00:00",
"date_update": "2026-09-23T02:48:07.3250346+00:00",
"date_closed": "2026-09-23T02:48:07.3250346+00:00",
"suggested_user_id": "e75dbb65-b5e5-4504-82e3-4c8d0b684753",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5559a9bf-caa1-429f-bc2e-e6a9631f3ffd",
"db_language_id": "4422eb2d-e6e7-4f66-8691-f16451411cf8",
"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-23T02:48:07.3250346+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0ce566cc-ed51-460f-bb4c-5d362e613d43",
"sales_organization": {
"id": "522a2899-96d8-4a4f-bb75-c5c2eb4f8b39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d31ddc-9ac2-4a84-8ff0-f88824b87219",
"db_currency_id": "2b3ba7f6-9f49-4e1d-9bfa-e2ac3a197b1f",
"db_language_id": "bb9878ad-911c-48ee-9e15-b112f77b8166",
"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-23T02:48:07.3250346+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4bf2c242-acf3-4360-b1c3-8aac127b4b84",
"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": "0e2a17ee-2555-43f4-b9ac-07c422281f1a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "65730ea4-24c5-4310-9f25-bfd7a3328540"
},
"suggested_date_start": "2026-09-23T02:48:07.3250346+00:00",
"skill_id": "2b8cbca5-95c1-45c7-866b-7e73bf4e69c4",
"skill_code": "sample string 32",
"skill": {
"id": "2e903513-8ae1-494f-a418-46996deb7c8a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ef369bab-3db7-4502-a854-b55791558220",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "522a2899-96d8-4a4f-bb75-c5c2eb4f8b39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45d31ddc-9ac2-4a84-8ff0-f88824b87219",
"db_currency_id": "2b3ba7f6-9f49-4e1d-9bfa-e2ac3a197b1f",
"db_language_id": "bb9878ad-911c-48ee-9e15-b112f77b8166",
"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-23T02:48:07.3250346+00:00"
},
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "83d3abaa-a522-4f7a-8d6e-179fbf87068f",
"date_reported_by_company": "2026-09-23T02:48:07.3250346+00:00",
"id2": 36,
"company_id": "44fe093d-d531-43ab-8cf4-a3b2febac2e7",
"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": "64c531f5-f843-4ae4-9e60-90a1903943d8",
"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-23T02:48:07.3250346+00:00"
},
"work_instruction_details_id": "ee272574-a85c-4db6-8d3e-07920e0b70ae",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9b053433-96d6-4c10-93b0-36cd47322ca8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d8f76e33-97fe-4454-8392-49edf5f9a89a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T02:48:07.3250346+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": "564b7145-87c3-47ce-a3e9-1b699e59de32",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T02:48:07.3250346+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.