Retrieves 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 :
None.
Response Information
Resource Description :
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 |
Response Formats
application/json, text/json
Sample:
{
"id": "b566aaf2-b94d-46ea-9c03-0262689357c5",
"jobs_id": "eb6dd36e-74ae-425b-ae15-11071a187995",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0c4c4acb-a9ad-46fb-bf16-279f882e14b2",
"_parent_id": "16d8992f-7832-4f59-8512-838c31b0cb21",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8af3e6bf-2b6f-474d-8e13-5a04a119ab65",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0d6e52be-9ae9-4dad-8aa8-c8e1c4a00082",
"_parent_id": "c5bc94dd-1df0-41ac-93dc-5bb73ca93855",
"root_parent_id": "4d230bf8-3390-48bd-9aa6-2a873cf62a27",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "42e65af7-8c1b-4ca3-bbd0-67dc5f1659ee",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cd9a9db3-09fd-4586-a5f4-cd28e924acc8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e22990b4-06a8-4547-b421-fb532c05c227",
"_parent_code": "sample string 6",
"sales_organization_id": "7efbe15c-4042-455a-b788-67e98f88a1a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "be5d1f52-c1ac-4517-a903-09f8081bd729",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41eda719-c543-4ca0-90a4-f252df157dd5",
"db_currency_id": "89ff6e6d-4431-4587-8870-f3ad13ccb5a0",
"db_language_id": "362370e8-6d7a-49d5-aa56-ec2cd9947bcd",
"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-12-14T18:02:23.899396+00:00"
},
"modified_dateutc": "2025-12-14T18:02:23.899396+00:00"
},
"equipment_model_id": "062cc9db-18ba-4580-9cc5-b4fac3162afd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "83416d10-491e-4d6a-962e-66f23a9b277a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4cbcd979-cc20-4058-8a98-1b643f54c95d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "08ad5443-e229-412e-8bb4-582a207be930",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7e8e5a73-b0d6-4914-bc20-1465a1d18cc7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be5d1f52-c1ac-4517-a903-09f8081bd729",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41eda719-c543-4ca0-90a4-f252df157dd5",
"db_currency_id": "89ff6e6d-4431-4587-8870-f3ad13ccb5a0",
"db_language_id": "362370e8-6d7a-49d5-aa56-ec2cd9947bcd",
"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-12-14T18:02:23.899396+00:00"
},
"modified_dateutc": "2025-12-14T18:02:23.899396+00:00"
},
"equipment_family_id": "ee3e557c-9a09-4ee4-a57f-473c5a82af1f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cd9a9db3-09fd-4586-a5f4-cd28e924acc8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e22990b4-06a8-4547-b421-fb532c05c227",
"_parent_code": "sample string 6",
"sales_organization_id": "7efbe15c-4042-455a-b788-67e98f88a1a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "be5d1f52-c1ac-4517-a903-09f8081bd729",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41eda719-c543-4ca0-90a4-f252df157dd5",
"db_currency_id": "89ff6e6d-4431-4587-8870-f3ad13ccb5a0",
"db_language_id": "362370e8-6d7a-49d5-aa56-ec2cd9947bcd",
"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-12-14T18:02:23.899396+00:00"
},
"modified_dateutc": "2025-12-14T18:02:23.899396+00:00"
},
"date_in_production_since": "2025-12-14T18:02:23.899396+00:00",
"date_out_of_production_since": "2025-12-14T18:02:23.899396+00:00",
"date_end_support": "2025-12-14T18:02:23.899396+00:00",
"sales_organization_id": "889f4223-ef88-4790-94a2-73a9636ca613",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "be5d1f52-c1ac-4517-a903-09f8081bd729",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41eda719-c543-4ca0-90a4-f252df157dd5",
"db_currency_id": "89ff6e6d-4431-4587-8870-f3ad13ccb5a0",
"db_language_id": "362370e8-6d7a-49d5-aa56-ec2cd9947bcd",
"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-12-14T18:02:23.899396+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-12-14T18:02:23.899396+00:00"
},
"project_status_id": "bf087a08-071c-4424-a245-52bc3028cc1c",
"project_status_code": "sample string 10",
"project_status": {
"id": "e83ff4ac-5da7-41ea-bab1-45b6d2d26849",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bfb4fb58-fe59-4120-8051-8ba84c5843b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be5d1f52-c1ac-4517-a903-09f8081bd729",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41eda719-c543-4ca0-90a4-f252df157dd5",
"db_currency_id": "89ff6e6d-4431-4587-8870-f3ad13ccb5a0",
"db_language_id": "362370e8-6d7a-49d5-aa56-ec2cd9947bcd",
"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-12-14T18:02:23.899396+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-14T18:02:23.899396+00:00"
},
"company_id": "dd72db95-8566-4a96-b4d9-57bb2855e574",
"company_code": "sample string 12",
"db_address_id": "e4d3d3b1-7769-48e6-b982-d0f96019741e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "583ac330-0303-4e57-9bbb-6db9c132aa2c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6943de4b-4912-424b-a530-9abe79f51d9f",
"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-12-14T18:02:23.899396+00:00",
"date_create": "2025-12-14T18:02:23.899396+00:00",
"date_update": "2025-12-14T18:02:23.899396+00:00",
"updated_by_user_id": "38ea47b4-680a-4f69-8ffb-2e23c7d41fe6",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-14T18:02:23.899396+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-12-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-14T18:02:23.899396+00:00",
"date_last_job": "2025-12-14T18:02:23.899396+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-14T18:02:23.899396+00:00",
"modified_dateutc": "2025-12-14T18:02:23.899396+00:00",
"is_mobile_installation": true
},
"job_type_id": "1ce11db5-7a94-4b23-8d76-3c4564f3dbe5",
"job_type_code": "sample string 7",
"job_type": {
"id": "4e914edd-c78a-4ccb-b1d1-157870f84b21",
"name": "sample string 2",
"sales_organization_id": "72f7f192-4083-4430-bb70-b063a909f933",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-14T18:02:23.899396+00:00",
"code": "sample string 7"
},
"job_priority_id": "7f061c4c-5052-4b60-89f9-6f5fa9acd37f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fc535ccb-0955-4a89-adb8-232909eeef9d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dcfc85b1-08b8-4c11-9dda-1e6ae46d2ab6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be5d1f52-c1ac-4517-a903-09f8081bd729",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41eda719-c543-4ca0-90a4-f252df157dd5",
"db_currency_id": "89ff6e6d-4431-4587-8870-f3ad13ccb5a0",
"db_language_id": "362370e8-6d7a-49d5-aa56-ec2cd9947bcd",
"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-12-14T18:02:23.899396+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-14T18:02:23.899396+00:00"
},
"job_status_id": "2f85a515-5f4b-465d-bec3-61e68c7d31cb",
"job_status_code": "sample string 11",
"db_address_id": "3d4f2544-646e-4575-b1cd-8d6724fc841a",
"contact_id": "37053cf9-661c-4e81-9b60-e9db88bf972a",
"requested_by_company_id": "ac8d6dd7-c7a6-4fb6-a158-719a2bbf34be",
"requested_by_contact_id": "dfc116d4-c497-4076-b612-9e39a56b6adb",
"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-12-14T18:02:23.899396+00:00",
"due_date": "2025-12-14T18:02:23.899396+00:00",
"date_create": "2025-12-14T18:02:23.899396+00:00",
"date_update": "2025-12-14T18:02:23.899396+00:00",
"date_closed": "2025-12-14T18:02:23.899396+00:00",
"suggested_user_id": "9545de34-e775-469f-9ba6-d6dde32ba609",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "adc18bec-d952-4749-ba76-30262ae18b53",
"db_language_id": "a53f90bc-5665-44a5-a89e-794a8cab6dde",
"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-12-14T18:02:23.899396+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "85f19263-fc2b-463f-a8a5-be574b4db4d5",
"sales_organization": {
"id": "be5d1f52-c1ac-4517-a903-09f8081bd729",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41eda719-c543-4ca0-90a4-f252df157dd5",
"db_currency_id": "89ff6e6d-4431-4587-8870-f3ad13ccb5a0",
"db_language_id": "362370e8-6d7a-49d5-aa56-ec2cd9947bcd",
"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-12-14T18:02:23.899396+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "356e7130-2ea3-4efd-a198-c5b7b4c1272f",
"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": "25e6514d-5538-48a2-93ca-414e2b948bf9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-14T18:02:23.899396+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "da4f1def-7e38-42db-8c44-26902eb4c7dd"
},
"suggested_date_start": "2025-12-14T18:02:23.899396+00:00",
"skill_id": "48c77598-65d0-4164-b7f1-8e669805fb1b",
"skill_code": "sample string 32",
"skill": {
"id": "bd516285-42f6-44cc-b5a1-9f4c0ef441f9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "697fffe3-8967-4221-9717-c3bacc45b31f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be5d1f52-c1ac-4517-a903-09f8081bd729",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41eda719-c543-4ca0-90a4-f252df157dd5",
"db_currency_id": "89ff6e6d-4431-4587-8870-f3ad13ccb5a0",
"db_language_id": "362370e8-6d7a-49d5-aa56-ec2cd9947bcd",
"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-12-14T18:02:23.899396+00:00"
},
"modified_dateutc": "2025-12-14T18:02:23.899396+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8a767288-344c-437e-a860-450556a5f12e",
"date_reported_by_company": "2025-12-14T18:02:23.899396+00:00",
"id2": 36,
"company_id": "483e77a5-7660-416d-b160-81e792245039",
"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": "e0d6e3a2-85fe-4a67-ad06-ffe19ae7542e",
"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-12-14T18:02:23.899396+00:00"
},
"work_instruction_details_id": "94037ffd-78c6-4c46-876e-80437c84c5f8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fabf6e01-b069-4b0d-8e34-ec02d1cf81bb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "75e46607-dec6-4379-8d49-eff0ad632c27",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-14T18:02:23.9150211+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": "ff57df34-9ced-4967-b667-ffb7301e9d4b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-14T18:02:23.9150211+00:00"
}