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": "dd015e87-980c-447f-af37-d5b20ab7f75f",
"jobs_id": "ab97babe-bbe7-41fb-a253-be7cb8e4734a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ae9e4801-4e78-483a-ac3d-9b4bcce08506",
"_parent_id": "33732411-4939-4423-9551-528ddf4e5d53",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "13765b7d-ff5b-4726-97f2-8e5e9a51a766",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ee8c1b5e-401d-40eb-9d24-4d6741f47a53",
"_parent_id": "3e1920bf-ace3-4f11-8229-32ac9ad36251",
"root_parent_id": "60c71d18-93df-464c-bb03-d79a99317ab7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a6f32115-4fb5-4d66-a97c-0aba86c1362c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b3b2c535-ea2c-434e-86ff-74da65051602",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6ca0f131-5d60-47ef-9683-fc32c03aac3f",
"_parent_code": "sample string 6",
"sales_organization_id": "8edeb71d-b1a5-4226-bc34-6a4d4ecad01c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac0b909c-ce9d-43ae-abfe-183cb0606df9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c534a23e-f6ca-4af3-bf70-03562b5420cd",
"db_currency_id": "8a5bec46-9540-4c38-b1d7-6c6d366311d8",
"db_language_id": "9277dc78-3c6f-4aca-a5fd-f335a06424dc",
"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-07-11T03:12:02.070928+00:00"
},
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00"
},
"equipment_model_id": "0aeabcd8-1033-45e3-b690-179e8245d243",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bd54f56f-cccc-4a8e-acfc-14117236d245",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c95771ce-f1a7-4a0c-9313-cf0bdd2059fc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7ef9f3d8-341d-4ac6-9d6f-1c62eef61714",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "307efb2b-beb7-4570-b72f-79ce6d53fa7c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ac0b909c-ce9d-43ae-abfe-183cb0606df9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c534a23e-f6ca-4af3-bf70-03562b5420cd",
"db_currency_id": "8a5bec46-9540-4c38-b1d7-6c6d366311d8",
"db_language_id": "9277dc78-3c6f-4aca-a5fd-f335a06424dc",
"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-07-11T03:12:02.070928+00:00"
},
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00"
},
"equipment_family_id": "342e8b9d-3943-4d88-821c-a4bed81cc792",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b3b2c535-ea2c-434e-86ff-74da65051602",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6ca0f131-5d60-47ef-9683-fc32c03aac3f",
"_parent_code": "sample string 6",
"sales_organization_id": "8edeb71d-b1a5-4226-bc34-6a4d4ecad01c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac0b909c-ce9d-43ae-abfe-183cb0606df9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c534a23e-f6ca-4af3-bf70-03562b5420cd",
"db_currency_id": "8a5bec46-9540-4c38-b1d7-6c6d366311d8",
"db_language_id": "9277dc78-3c6f-4aca-a5fd-f335a06424dc",
"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-07-11T03:12:02.070928+00:00"
},
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00"
},
"date_in_production_since": "2026-07-11T03:12:02.070928+00:00",
"date_out_of_production_since": "2026-07-11T03:12:02.070928+00:00",
"date_end_support": "2026-07-11T03:12:02.070928+00:00",
"sales_organization_id": "89b9bad1-9dd7-425f-83e1-40e0806a5058",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ac0b909c-ce9d-43ae-abfe-183cb0606df9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c534a23e-f6ca-4af3-bf70-03562b5420cd",
"db_currency_id": "8a5bec46-9540-4c38-b1d7-6c6d366311d8",
"db_language_id": "9277dc78-3c6f-4aca-a5fd-f335a06424dc",
"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-07-11T03:12:02.070928+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-07-11T03:12:02.070928+00:00"
},
"project_status_id": "7a25f9dd-32d4-43a8-8f2d-3663c7dddcbd",
"project_status_code": "sample string 10",
"project_status": {
"id": "2c997dc6-769b-4c20-8b51-5ccd2a647d14",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0cc8a498-4d6e-44f6-a5b5-3208dfecf067",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac0b909c-ce9d-43ae-abfe-183cb0606df9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c534a23e-f6ca-4af3-bf70-03562b5420cd",
"db_currency_id": "8a5bec46-9540-4c38-b1d7-6c6d366311d8",
"db_language_id": "9277dc78-3c6f-4aca-a5fd-f335a06424dc",
"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-07-11T03:12:02.070928+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00"
},
"company_id": "97c5bf07-b383-4445-b049-03a57550440a",
"company_code": "sample string 12",
"db_address_id": "dc99f081-e88b-41d6-b327-88d7b8dfc6c5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9724e468-71b3-46f5-a40f-4a98b3b71f0a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e776cb3d-fae3-4928-b45c-d2e16b20d811",
"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-07-11T03:12:02.070928+00:00",
"date_create": "2026-07-11T03:12:02.070928+00:00",
"date_update": "2026-07-11T03:12:02.070928+00:00",
"updated_by_user_id": "1a81a45a-a0e3-43d9-bd47-33c21412ae82",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-11T03:12:02.070928+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-07-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-11T03:12:02.070928+00:00",
"date_last_job": "2026-07-11T03:12:02.070928+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-11T03:12:02.070928+00:00",
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00",
"is_mobile_installation": true
},
"job_type_id": "d80525f1-77cb-4fef-b298-37cf11d69876",
"job_type_code": "sample string 7",
"job_type": {
"id": "b2fc6e99-73bc-4e00-bd5d-b751ab67e985",
"name": "sample string 2",
"sales_organization_id": "e4b44c01-564d-4a2e-b0f4-4e9d42a2c522",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00",
"code": "sample string 7"
},
"job_priority_id": "23eae9e9-c7f9-440a-b6c5-8efc6a0a5524",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e5579b9b-3329-4aa6-a354-8177ab0961db",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "82449bdb-97bf-49d2-9a2f-29568ee2cccd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac0b909c-ce9d-43ae-abfe-183cb0606df9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c534a23e-f6ca-4af3-bf70-03562b5420cd",
"db_currency_id": "8a5bec46-9540-4c38-b1d7-6c6d366311d8",
"db_language_id": "9277dc78-3c6f-4aca-a5fd-f335a06424dc",
"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-07-11T03:12:02.070928+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00"
},
"job_status_id": "8cbf7de2-41c9-41e7-ba87-aab43e61ce1f",
"job_status_code": "sample string 11",
"db_address_id": "4328d14c-6a6d-4210-a482-d5f76ba87ed9",
"contact_id": "5c7cb13d-90e2-42d4-9c01-d9ffaa4ec62e",
"requested_by_company_id": "387e85f7-9645-42be-affc-c5ff1f27f7d0",
"requested_by_contact_id": "1e666bdb-35ee-4d63-92f6-ec2eb3c536a8",
"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-07-11T03:12:02.070928+00:00",
"due_date": "2026-07-11T03:12:02.070928+00:00",
"date_create": "2026-07-11T03:12:02.070928+00:00",
"date_update": "2026-07-11T03:12:02.070928+00:00",
"date_closed": "2026-07-11T03:12:02.070928+00:00",
"suggested_user_id": "e957e4b3-2444-42fd-9aa4-bfdaa5a5ecb3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c4d6a364-ad74-4740-a0d7-7519e3f2e6c8",
"db_language_id": "fdd92797-ffbb-43bd-8b01-4261f0ca0e74",
"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-07-11T03:12:02.070928+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "23d37258-aef9-44fd-bb29-12633fc3d5d3",
"sales_organization": {
"id": "ac0b909c-ce9d-43ae-abfe-183cb0606df9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c534a23e-f6ca-4af3-bf70-03562b5420cd",
"db_currency_id": "8a5bec46-9540-4c38-b1d7-6c6d366311d8",
"db_language_id": "9277dc78-3c6f-4aca-a5fd-f335a06424dc",
"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-07-11T03:12:02.070928+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cfacadfb-b877-4ff1-a79d-40327d6831b1",
"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": "07ef0595-795d-4858-bb8e-041ea98332b1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2fe6ebbf-1934-4745-a498-84762105f002"
},
"suggested_date_start": "2026-07-11T03:12:02.070928+00:00",
"skill_id": "c4fd4551-716f-47be-b3ce-daf210420cbd",
"skill_code": "sample string 32",
"skill": {
"id": "79b95c1e-b78e-4185-8520-52f310d711e0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dc3e6e7d-b409-464b-af5f-133970e4a217",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac0b909c-ce9d-43ae-abfe-183cb0606df9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c534a23e-f6ca-4af3-bf70-03562b5420cd",
"db_currency_id": "8a5bec46-9540-4c38-b1d7-6c6d366311d8",
"db_language_id": "9277dc78-3c6f-4aca-a5fd-f335a06424dc",
"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-07-11T03:12:02.070928+00:00"
},
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a09d4f8a-63f8-477b-9146-857d94e08064",
"date_reported_by_company": "2026-07-11T03:12:02.070928+00:00",
"id2": 36,
"company_id": "efffe7da-049f-42e0-87d1-717048e29202",
"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": "e2f77e36-f5f6-4e76-aceb-541910b5df32",
"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-07-11T03:12:02.070928+00:00"
},
"work_instruction_details_id": "ea55306f-2152-4664-92bc-0b4d31d279ca",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "166a5783-88ae-4c0e-817f-2324e12501f3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "202b9fdb-b83c-48a0-bcbc-cc2aa9702cf6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-11T03:12:02.070928+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": "18dadf23-d2a6-460a-82bb-03ad4be73966",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-11T03:12:02.070928+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.