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": "76ba1199-1742-45c9-bfd3-f2c887a4ded0",
"jobs_id": "b708cfa0-9f3b-4b18-8fad-b7a149c752b4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "db59e666-fd90-4cae-9ad7-a69fe8b4c300",
"_parent_id": "34442ff9-974d-4ee1-b9f5-1b3deffe7b45",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "86396667-ef79-4336-b080-b490ae8e940b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "43cde0b7-5b09-4679-a7cd-1f5c28a6acb2",
"_parent_id": "f42520c2-0043-4243-8f15-561327ad7e20",
"root_parent_id": "5f58078c-fff1-4ef9-bdea-0cb62bef2c7a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4b4998b1-208c-4697-b78f-0db178f9ea85",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "03885075-4536-4aa6-a7d5-87ee236c6bab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b27617f6-415e-4083-9f28-4583fb2937c3",
"_parent_code": "sample string 6",
"sales_organization_id": "180d5859-5a72-44bf-ae8c-0649276589f0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eab9dae3-0524-4f4e-8a3b-91798cf8e8cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4de3bf8-485a-4273-a087-8796d84c755d",
"db_currency_id": "0d497b87-4c31-4220-9b7c-c8ab86e3c05f",
"db_language_id": "63933616-f4e8-428f-94f3-875664af361f",
"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-08T03:26:42.724987+00:00"
},
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00"
},
"equipment_model_id": "991bddc7-9234-4db2-9e17-ca20f58a97b0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c7b37425-cef5-4705-99d9-1876316220a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "87777f59-0ea3-4517-8341-c851f6bf0150",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ee16e7bd-ac16-496d-a41b-51e68a8de394",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "af7c09b2-d0ba-4272-bea0-32a95249d755",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eab9dae3-0524-4f4e-8a3b-91798cf8e8cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4de3bf8-485a-4273-a087-8796d84c755d",
"db_currency_id": "0d497b87-4c31-4220-9b7c-c8ab86e3c05f",
"db_language_id": "63933616-f4e8-428f-94f3-875664af361f",
"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-08T03:26:42.724987+00:00"
},
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00"
},
"equipment_family_id": "eec882a6-8af9-4a8c-8f9f-fa7ea696c581",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "03885075-4536-4aa6-a7d5-87ee236c6bab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b27617f6-415e-4083-9f28-4583fb2937c3",
"_parent_code": "sample string 6",
"sales_organization_id": "180d5859-5a72-44bf-ae8c-0649276589f0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eab9dae3-0524-4f4e-8a3b-91798cf8e8cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4de3bf8-485a-4273-a087-8796d84c755d",
"db_currency_id": "0d497b87-4c31-4220-9b7c-c8ab86e3c05f",
"db_language_id": "63933616-f4e8-428f-94f3-875664af361f",
"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-08T03:26:42.724987+00:00"
},
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00"
},
"date_in_production_since": "2025-12-08T03:26:42.724987+00:00",
"date_out_of_production_since": "2025-12-08T03:26:42.724987+00:00",
"date_end_support": "2025-12-08T03:26:42.724987+00:00",
"sales_organization_id": "d977a2c3-0999-47bc-8dbc-c8e9ea79f943",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eab9dae3-0524-4f4e-8a3b-91798cf8e8cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4de3bf8-485a-4273-a087-8796d84c755d",
"db_currency_id": "0d497b87-4c31-4220-9b7c-c8ab86e3c05f",
"db_language_id": "63933616-f4e8-428f-94f3-875664af361f",
"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-08T03:26:42.724987+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-08T03:26:42.724987+00:00"
},
"project_status_id": "c064ee68-db81-40f8-bfbb-340542a664c8",
"project_status_code": "sample string 10",
"project_status": {
"id": "f338da14-39e1-4db8-b867-157880d2ad37",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "539a8bd7-8fe0-4c1e-8eb8-ea046052a883",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eab9dae3-0524-4f4e-8a3b-91798cf8e8cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4de3bf8-485a-4273-a087-8796d84c755d",
"db_currency_id": "0d497b87-4c31-4220-9b7c-c8ab86e3c05f",
"db_language_id": "63933616-f4e8-428f-94f3-875664af361f",
"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-08T03:26:42.724987+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00"
},
"company_id": "b429212e-1fd9-4cd3-b482-f62777ec9793",
"company_code": "sample string 12",
"db_address_id": "8d98e31c-267b-49c1-b9b6-39465c5d11dd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e52502a6-c9c8-4e0c-8849-667624bee524",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "46789f11-e502-4d80-baaf-b0abbabaf870",
"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-08T03:26:42.724987+00:00",
"date_create": "2025-12-08T03:26:42.724987+00:00",
"date_update": "2025-12-08T03:26:42.724987+00:00",
"updated_by_user_id": "941a9757-1bcb-4f61-a161-35e470a9afdc",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-08T03:26:42.724987+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-08T03:26:42.724987+00:00",
"date_last_job": "2025-12-08T03:26:42.724987+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-08T03:26:42.724987+00:00",
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00",
"is_mobile_installation": true
},
"job_type_id": "27e7b0b7-9ac8-4fb0-b3a2-444b5259b06c",
"job_type_code": "sample string 7",
"job_type": {
"id": "c8a43835-c948-4735-8e3c-72c3724eac52",
"name": "sample string 2",
"sales_organization_id": "c1bdf935-2c10-4a6e-9d9d-1a8063b3f9c4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00",
"code": "sample string 7"
},
"job_priority_id": "d88653a9-9483-4bc8-be99-cc7943bfc302",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4ab30d30-0631-42f7-8b1c-1136cd43d875",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "44d40f99-2b0b-46f1-ae84-eae25450fe11",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eab9dae3-0524-4f4e-8a3b-91798cf8e8cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4de3bf8-485a-4273-a087-8796d84c755d",
"db_currency_id": "0d497b87-4c31-4220-9b7c-c8ab86e3c05f",
"db_language_id": "63933616-f4e8-428f-94f3-875664af361f",
"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-08T03:26:42.724987+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00"
},
"job_status_id": "d67af261-84c9-4976-b3e3-e1ea08033fe2",
"job_status_code": "sample string 11",
"db_address_id": "12f4014f-c721-447f-acaf-176ca91346f0",
"contact_id": "482fb063-d05b-4fde-b340-98c2f433214c",
"requested_by_company_id": "121c8847-a78d-493c-a07d-0a653504a3e5",
"requested_by_contact_id": "cd55e379-c444-41b0-8d2f-3c1a9fe3f09f",
"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-08T03:26:42.724987+00:00",
"due_date": "2025-12-08T03:26:42.724987+00:00",
"date_create": "2025-12-08T03:26:42.724987+00:00",
"date_update": "2025-12-08T03:26:42.724987+00:00",
"date_closed": "2025-12-08T03:26:42.724987+00:00",
"suggested_user_id": "91a5422c-aeb4-4316-be10-f558f1f1864d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "87b591c8-aea4-4f33-a066-0be26a95a8e6",
"db_language_id": "7a3041c4-3366-465b-839e-0b0de6587eeb",
"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-08T03:26:42.724987+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc919c68-64e7-4650-9390-12abeac963b3",
"sales_organization": {
"id": "eab9dae3-0524-4f4e-8a3b-91798cf8e8cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4de3bf8-485a-4273-a087-8796d84c755d",
"db_currency_id": "0d497b87-4c31-4220-9b7c-c8ab86e3c05f",
"db_language_id": "63933616-f4e8-428f-94f3-875664af361f",
"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-08T03:26:42.724987+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7d9e901d-cef8-4738-ad20-e4b9677c3e74",
"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": "ef93544b-40a8-42d7-ab72-36773e11cc85",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ff51cc22-ab57-4ea3-a600-3973198bb89e"
},
"suggested_date_start": "2025-12-08T03:26:42.724987+00:00",
"skill_id": "02549b0f-fdc0-412a-87b3-abb415aaf6cd",
"skill_code": "sample string 32",
"skill": {
"id": "19d2acc7-6bed-45fe-a7f9-0fc846c6fa25",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "784dd784-ac8b-4a1b-8342-761e673d363a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eab9dae3-0524-4f4e-8a3b-91798cf8e8cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4de3bf8-485a-4273-a087-8796d84c755d",
"db_currency_id": "0d497b87-4c31-4220-9b7c-c8ab86e3c05f",
"db_language_id": "63933616-f4e8-428f-94f3-875664af361f",
"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-08T03:26:42.724987+00:00"
},
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4f44adef-8b18-4b6c-a52f-413bcd2bccad",
"date_reported_by_company": "2025-12-08T03:26:42.724987+00:00",
"id2": 36,
"company_id": "e45b6776-51d1-4265-a40d-67d6e2cc6be4",
"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": "33741f64-cd3a-4045-9a5c-2554b9f9a2f6",
"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-08T03:26:42.724987+00:00"
},
"work_instruction_details_id": "4f9efee4-03a9-43e4-9167-dcde7d30bccc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2dd6aa8a-852c-4d4b-8ef1-17e20110f9cb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "21d4f2e0-c47f-47ac-b7a9-decde77374a2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-08T03:26:42.724987+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": "71563744-9c03-4ccc-a4d7-8614c7c85517",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-08T03:26:42.724987+00:00"
}