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": "73891b20-d8e5-4a96-a3b1-eb8c32a13e5b",
"jobs_id": "5664d65d-dab3-4877-93c7-f93cba3e51d7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "21945b57-5abd-4f46-a08a-18bd8d5927ca",
"_parent_id": "931c870a-02d8-45cf-9a09-63505c9c89e0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "624fde11-4324-4454-b399-0cd6beac6de5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0a908bc1-0c68-4d75-9f7a-e14986e5b3d3",
"_parent_id": "ee1ed149-0b91-4b23-964b-0049fd3e6d86",
"root_parent_id": "6db39a6c-5814-4819-89fd-6d99ba1a0f1c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "93849108-0206-49cb-801c-a0f3c7477b1a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8985a7fd-38e9-4cb3-80e1-192057549736",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3c5d08ba-8641-4f5f-9d8a-4cba610e31c8",
"_parent_code": "sample string 6",
"sales_organization_id": "dbc8ba9a-9678-434d-83ae-5e15527d2bb1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "976d4c76-c762-4ab5-8c6f-21ca81379d86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd5ab5d-8d60-4b3a-aa65-7286726e7b99",
"db_currency_id": "65a233d7-2479-4309-8fd2-e1ee0dcc9de8",
"db_language_id": "fcce6f0d-0902-457d-8d29-e1b3950e909b",
"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-29T13:10:39.007782+00:00"
},
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00"
},
"equipment_model_id": "506ceafe-0209-4c3d-9283-547397fb4a09",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a4317942-e374-4eda-877c-13c56a903e36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "be65be56-7e04-47a3-8dfd-db28e088d907",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8eb519ad-965c-471c-ad5e-5852d36de127",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "81359004-0e3b-47d4-a56f-bdc22c488955",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "976d4c76-c762-4ab5-8c6f-21ca81379d86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd5ab5d-8d60-4b3a-aa65-7286726e7b99",
"db_currency_id": "65a233d7-2479-4309-8fd2-e1ee0dcc9de8",
"db_language_id": "fcce6f0d-0902-457d-8d29-e1b3950e909b",
"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-29T13:10:39.007782+00:00"
},
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00"
},
"equipment_family_id": "49f0fa62-dab2-45df-b34c-19fc0f8c82ca",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8985a7fd-38e9-4cb3-80e1-192057549736",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3c5d08ba-8641-4f5f-9d8a-4cba610e31c8",
"_parent_code": "sample string 6",
"sales_organization_id": "dbc8ba9a-9678-434d-83ae-5e15527d2bb1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "976d4c76-c762-4ab5-8c6f-21ca81379d86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd5ab5d-8d60-4b3a-aa65-7286726e7b99",
"db_currency_id": "65a233d7-2479-4309-8fd2-e1ee0dcc9de8",
"db_language_id": "fcce6f0d-0902-457d-8d29-e1b3950e909b",
"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-29T13:10:39.007782+00:00"
},
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00"
},
"date_in_production_since": "2026-07-29T13:10:39.007782+00:00",
"date_out_of_production_since": "2026-07-29T13:10:39.007782+00:00",
"date_end_support": "2026-07-29T13:10:39.007782+00:00",
"sales_organization_id": "7ec2898e-ec4c-45e7-a5c5-e463190fb2fd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "976d4c76-c762-4ab5-8c6f-21ca81379d86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd5ab5d-8d60-4b3a-aa65-7286726e7b99",
"db_currency_id": "65a233d7-2479-4309-8fd2-e1ee0dcc9de8",
"db_language_id": "fcce6f0d-0902-457d-8d29-e1b3950e909b",
"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-29T13:10:39.007782+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-29T13:10:39.007782+00:00"
},
"project_status_id": "b7454f34-4f80-47e0-81d2-8fc42cac3194",
"project_status_code": "sample string 10",
"project_status": {
"id": "e87574e2-8622-49e9-95b4-831521cdc49f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b44d5992-0ebc-4e9e-b6f6-26b0b748a250",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "976d4c76-c762-4ab5-8c6f-21ca81379d86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd5ab5d-8d60-4b3a-aa65-7286726e7b99",
"db_currency_id": "65a233d7-2479-4309-8fd2-e1ee0dcc9de8",
"db_language_id": "fcce6f0d-0902-457d-8d29-e1b3950e909b",
"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-29T13:10:39.007782+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00"
},
"company_id": "c8a1d068-483a-43df-972b-1b3f814842cf",
"company_code": "sample string 12",
"db_address_id": "9f9d4a1b-45ca-4902-8e1f-ebcbf7957857",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6a147055-daf1-4ce6-9398-3f1026dfc0db",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ca51218a-33c7-4f9d-b479-492da6b38812",
"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-29T13:10:39.007782+00:00",
"date_create": "2026-07-29T13:10:39.007782+00:00",
"date_update": "2026-07-29T13:10:39.007782+00:00",
"updated_by_user_id": "6d2fe93f-f61c-4584-b1ef-4dbb2eb8ccef",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-29T13:10:39.007782+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-29T13:10:39.007782+00:00",
"date_last_job": "2026-07-29T13:10:39.007782+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-29T13:10:39.007782+00:00",
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00",
"is_mobile_installation": true
},
"job_type_id": "8ce90781-fe4b-43cb-9932-7071aab8256d",
"job_type_code": "sample string 7",
"job_type": {
"id": "877e065b-bcc9-4b98-805b-e2ea2d48b508",
"name": "sample string 2",
"sales_organization_id": "a45c3da6-758e-42b1-bf0e-2b3e5b4efeb4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00",
"code": "sample string 7"
},
"job_priority_id": "ad8dbdda-b9a2-40f3-b990-dedd7534e24f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3bbd5e61-2653-4228-a079-2ff3382c36e5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f24287ed-69d3-4d80-a300-7083a3d1b0c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "976d4c76-c762-4ab5-8c6f-21ca81379d86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd5ab5d-8d60-4b3a-aa65-7286726e7b99",
"db_currency_id": "65a233d7-2479-4309-8fd2-e1ee0dcc9de8",
"db_language_id": "fcce6f0d-0902-457d-8d29-e1b3950e909b",
"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-29T13:10:39.007782+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00"
},
"job_status_id": "4e8ff5db-62bf-4155-8cfe-809084179224",
"job_status_code": "sample string 11",
"db_address_id": "e9e0f3ed-99db-431d-93d8-ab2d13ff0fa7",
"contact_id": "88a77ff1-143d-484e-91a2-dd4bc2438ca1",
"requested_by_company_id": "9cfc395e-f59d-4d39-8467-02d8f6eb5512",
"requested_by_contact_id": "1c279946-1ee6-4460-8fb0-c6d5ed5dd0a0",
"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-29T13:10:39.007782+00:00",
"due_date": "2026-07-29T13:10:39.007782+00:00",
"date_create": "2026-07-29T13:10:39.007782+00:00",
"date_update": "2026-07-29T13:10:39.007782+00:00",
"date_closed": "2026-07-29T13:10:39.007782+00:00",
"suggested_user_id": "38f01c5a-fea6-48ae-a97c-caa142c3d596",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8e185532-5103-493f-a4a9-f0ff2888ed37",
"db_language_id": "c428f2fb-4628-4a35-9d95-e6068031f14c",
"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-29T13:10:39.007782+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "45947a54-0bf2-42ac-81e1-8ebff199077a",
"sales_organization": {
"id": "976d4c76-c762-4ab5-8c6f-21ca81379d86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd5ab5d-8d60-4b3a-aa65-7286726e7b99",
"db_currency_id": "65a233d7-2479-4309-8fd2-e1ee0dcc9de8",
"db_language_id": "fcce6f0d-0902-457d-8d29-e1b3950e909b",
"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-29T13:10:39.007782+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0669ee63-3289-4af3-b1fb-945f61a9162c",
"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": "53dd9f2f-07b9-4dc2-a5d9-689807c527f1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b9d842fe-6db5-46d7-8c8c-4fe2c3a098a3"
},
"suggested_date_start": "2026-07-29T13:10:39.007782+00:00",
"skill_id": "6c827c4a-a0bf-4b11-813f-48c23dfb9b06",
"skill_code": "sample string 32",
"skill": {
"id": "910983b7-e5dc-44cc-a709-4d0c1ac400f7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ff76f346-28ee-45fd-adca-89d681086475",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "976d4c76-c762-4ab5-8c6f-21ca81379d86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd5ab5d-8d60-4b3a-aa65-7286726e7b99",
"db_currency_id": "65a233d7-2479-4309-8fd2-e1ee0dcc9de8",
"db_language_id": "fcce6f0d-0902-457d-8d29-e1b3950e909b",
"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-29T13:10:39.007782+00:00"
},
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7d032fd5-a7bf-4dc8-97ac-808d3a7142db",
"date_reported_by_company": "2026-07-29T13:10:39.007782+00:00",
"id2": 36,
"company_id": "9bc51ff1-2846-475b-bc86-84f4b1c18798",
"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": "ac89c7b1-6d45-4f1b-a043-59165cb5ec08",
"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-29T13:10:39.007782+00:00"
},
"work_instruction_details_id": "1df5070b-53d2-4f1e-8e8a-1ea3624f58c0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "76ce095a-369c-46d6-b929-0ba74519b997",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0a6588fe-e095-456b-8e44-13343cf1c4a9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-29T13:10:39.007782+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": "8b266276-54b6-47b5-a35a-125901699c4c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-29T13:10:39.007782+00:00"
}