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": "424232c8-4258-4c3d-8811-f26730d2f17f",
"jobs_id": "63eefa36-065d-4fa7-a46b-83fbf7e47472",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1ab38598-536a-44b5-adb7-bbabc166c117",
"_parent_id": "17ba914f-9834-4958-969c-86c25610d2e2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ae8531ff-f9be-46f6-aca0-8795dfe657f9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7ddbc42e-7ac1-4da3-913e-9d8483cdb68b",
"_parent_id": "c81e56d2-a526-498c-86d4-6cf484ee7fbc",
"root_parent_id": "0626637f-e871-46aa-a055-f9faf5543ab2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ffb7c5d9-ddab-48de-b282-a84f76257db1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9beb8c5a-d4c3-43fc-a856-132e6a33c956",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "32d222b4-5dbd-43cf-b7e3-2b685f0e1035",
"_parent_code": "sample string 6",
"sales_organization_id": "a0d629ab-d524-47c1-8cf3-b2be96108873",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e8cb1cc-787d-47c8-a5d4-1761954ddd03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01c92755-5f4d-46a2-bfdd-b9f1c7e06b5d",
"db_currency_id": "eb8c3e94-e742-4f9d-bd66-00e12eaf1145",
"db_language_id": "05792728-06f4-4307-8919-499f4f067566",
"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": "2025-11-23T07:17:50.0147916+00:00"
},
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00"
},
"equipment_model_id": "d913dc67-46a0-431b-a290-59cc9b0c6e21",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "03a26fe3-8a8c-45e2-8014-25e83f19228f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1d369f69-2b06-4b89-aeea-8eb5d616ae5a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "af3265c1-7fe3-470d-8807-dcdc5c7e3278",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "336397b2-86a5-4764-9b81-c913762b6eef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8e8cb1cc-787d-47c8-a5d4-1761954ddd03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01c92755-5f4d-46a2-bfdd-b9f1c7e06b5d",
"db_currency_id": "eb8c3e94-e742-4f9d-bd66-00e12eaf1145",
"db_language_id": "05792728-06f4-4307-8919-499f4f067566",
"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": "2025-11-23T07:17:50.0147916+00:00"
},
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00"
},
"equipment_family_id": "5272e583-35e6-423f-9d28-c616b797591d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9beb8c5a-d4c3-43fc-a856-132e6a33c956",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "32d222b4-5dbd-43cf-b7e3-2b685f0e1035",
"_parent_code": "sample string 6",
"sales_organization_id": "a0d629ab-d524-47c1-8cf3-b2be96108873",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e8cb1cc-787d-47c8-a5d4-1761954ddd03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01c92755-5f4d-46a2-bfdd-b9f1c7e06b5d",
"db_currency_id": "eb8c3e94-e742-4f9d-bd66-00e12eaf1145",
"db_language_id": "05792728-06f4-4307-8919-499f4f067566",
"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": "2025-11-23T07:17:50.0147916+00:00"
},
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00"
},
"date_in_production_since": "2025-11-23T07:17:50.0147916+00:00",
"date_out_of_production_since": "2025-11-23T07:17:50.0147916+00:00",
"date_end_support": "2025-11-23T07:17:50.0147916+00:00",
"sales_organization_id": "98b1128a-f630-433d-806f-9e8c1102a202",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8e8cb1cc-787d-47c8-a5d4-1761954ddd03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01c92755-5f4d-46a2-bfdd-b9f1c7e06b5d",
"db_currency_id": "eb8c3e94-e742-4f9d-bd66-00e12eaf1145",
"db_language_id": "05792728-06f4-4307-8919-499f4f067566",
"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": "2025-11-23T07:17:50.0147916+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": "2025-11-23T07:17:50.0147916+00:00"
},
"project_status_id": "43e08812-d51d-4d23-8918-8a221a492cd4",
"project_status_code": "sample string 10",
"project_status": {
"id": "bbd58702-c809-47af-9cb3-6396724790e0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "27bf211c-2022-4d14-aa0f-d759a6f0c6c0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e8cb1cc-787d-47c8-a5d4-1761954ddd03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01c92755-5f4d-46a2-bfdd-b9f1c7e06b5d",
"db_currency_id": "eb8c3e94-e742-4f9d-bd66-00e12eaf1145",
"db_language_id": "05792728-06f4-4307-8919-499f4f067566",
"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": "2025-11-23T07:17:50.0147916+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00"
},
"company_id": "8e67f232-afbc-4f44-8287-697b495e66d8",
"company_code": "sample string 12",
"db_address_id": "900513d6-eea6-4928-b6ff-55d27ec34dde",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8af83797-5a6a-453c-aee7-ae3ec47d7b1d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "172627d9-c0f7-48dc-a68a-6bc14d8a4018",
"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": "2025-11-23T07:17:50.0147916+00:00",
"date_create": "2025-11-23T07:17:50.0147916+00:00",
"date_update": "2025-11-23T07:17:50.0147916+00:00",
"updated_by_user_id": "2c45b39c-36de-4b9d-a92a-b67b2d7f0216",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-23T07:17:50.0147916+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": "2025-11-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-23T07:17:50.0147916+00:00",
"date_last_job": "2025-11-23T07:17:50.0147916+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-23T07:17:50.0147916+00:00",
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00",
"is_mobile_installation": true
},
"job_type_id": "5f23117a-6fd5-4c42-b09c-8041e028a5ba",
"job_type_code": "sample string 7",
"job_type": {
"id": "1d827c4e-758e-4779-bdff-dcc52a07cba2",
"name": "sample string 2",
"sales_organization_id": "27284f5b-058a-4e2f-a722-db8e5a06286b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00",
"code": "sample string 7"
},
"job_priority_id": "645ec2b4-64c5-460c-a748-6464848c795a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "53596770-8bf8-468d-b478-790f908ab447",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0483d5d5-c479-4a78-a7ba-4c16ce7b16eb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e8cb1cc-787d-47c8-a5d4-1761954ddd03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01c92755-5f4d-46a2-bfdd-b9f1c7e06b5d",
"db_currency_id": "eb8c3e94-e742-4f9d-bd66-00e12eaf1145",
"db_language_id": "05792728-06f4-4307-8919-499f4f067566",
"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": "2025-11-23T07:17:50.0147916+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00"
},
"job_status_id": "f1445ee6-6fa2-4308-a256-483260af437c",
"job_status_code": "sample string 11",
"db_address_id": "f2587634-65f8-448b-9159-534d26f0294a",
"contact_id": "b7da8d79-ef31-41d7-8bfb-b7dc04e253a0",
"requested_by_company_id": "51781f9c-c826-4cd6-bc3d-b83e0c68789a",
"requested_by_contact_id": "ea498b22-1d24-4ef7-9474-690f3354d0bf",
"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": "2025-11-23T07:17:50.0147916+00:00",
"due_date": "2025-11-23T07:17:50.0147916+00:00",
"date_create": "2025-11-23T07:17:50.0147916+00:00",
"date_update": "2025-11-23T07:17:50.0147916+00:00",
"date_closed": "2025-11-23T07:17:50.0147916+00:00",
"suggested_user_id": "8e0447d3-f2ef-4d05-8200-a755f8d2ad1a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dfc3052f-f2d8-44c0-b170-c5d21fee6c6d",
"db_language_id": "5df965d3-5fb9-4c98-86c4-4c684a4c3836",
"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": "2025-11-23T07:17:50.0147916+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bbd029ba-5a5d-45f1-8757-78872ace8703",
"sales_organization": {
"id": "8e8cb1cc-787d-47c8-a5d4-1761954ddd03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01c92755-5f4d-46a2-bfdd-b9f1c7e06b5d",
"db_currency_id": "eb8c3e94-e742-4f9d-bd66-00e12eaf1145",
"db_language_id": "05792728-06f4-4307-8919-499f4f067566",
"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": "2025-11-23T07:17:50.0147916+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "18186b82-b625-4333-b240-4e569df8043f",
"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": "d97a89f3-7e70-426d-81af-fb0aac4811f6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "27de8d85-9bf5-46f1-9264-d197e0768560"
},
"suggested_date_start": "2025-11-23T07:17:50.0147916+00:00",
"skill_id": "0eebafeb-aafe-4972-9ad2-1e3653204750",
"skill_code": "sample string 32",
"skill": {
"id": "7d47cd96-c5cc-4e34-bf87-59dddc13c70f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "537ba51a-a5c3-4a2a-a7e7-abc1bf0a1afe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e8cb1cc-787d-47c8-a5d4-1761954ddd03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01c92755-5f4d-46a2-bfdd-b9f1c7e06b5d",
"db_currency_id": "eb8c3e94-e742-4f9d-bd66-00e12eaf1145",
"db_language_id": "05792728-06f4-4307-8919-499f4f067566",
"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": "2025-11-23T07:17:50.0147916+00:00"
},
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8d4e2d9b-da09-4b49-89c8-ada05d0a77c3",
"date_reported_by_company": "2025-11-23T07:17:50.0147916+00:00",
"id2": 36,
"company_id": "bf06dbce-cd83-4884-a770-4da22cdf1413",
"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": "8c0fa752-5f4e-4df2-85f6-4b25c344c520",
"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": "2025-11-23T07:17:50.0147916+00:00"
},
"work_instruction_details_id": "d81b20c8-d834-43eb-b303-d1cb8a52317d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4a2d9d82-57d2-4ba6-b006-00b3528fc17e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "559a8917-db05-477c-8c2b-dae40f4687e0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-23T07:17:50.0147916+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": "8d876a78-4d13-4550-b007-d4dc1cd36c27",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-23T07:17:50.0147916+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.