Retrieves the work instruction 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 :
work_instructionName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier |
Required |
sales_organization_id |
FK of sales_organization. Filled if specific of one SO, empty if can be used by all |
globally unique identifier | |
sales_organization_code |
Embedded entity "sales_organization" using ERP PK when adding/updating work_instruction |
string | |
sales_organization |
Embedded entity "sales_organization" when adding/updating work_instruction |
sales_organization | |
job_type_id |
Applicable job_type |
globally unique identifier |
Required |
job_type_code |
Applicable job_type |
string | |
equipment_family_id |
Applicable equipment family |
globally unique identifier |
Required |
equipment_family_code |
Applicable equipment family |
string | |
skill_ids |
List of only applicable skils |
Collection of globally unique identifier | |
skill_codes |
List of only applicable skils |
Collection of string | |
name |
Name of the header of the work instruction. |
string |
Required Max length: 50 |
description |
Explanation of these instructions for the technician. |
string |
Required Max length: 255 |
estimated_work_time |
Time needed to complete these instructions. Number in minute. |
integer | |
additional_information |
Additional information |
string |
Max length: 4000 |
reference_back_office |
The Id/Ref of the back office for this work instruction. Used by Embedded entity |
string |
Max length: 255 |
is_required |
If true then all instructions required to be executed |
boolean | |
is_archived |
Specify if the object is not usable anymore |
boolean | |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating. |
date |
Response Formats
application/json, text/json
{ "id": "0828c702-e5f5-4bb0-b25c-cde525574b07", "sales_organization_id": "74d5d2c7-8439-424e-9640-052f40a9ada9", "sales_organization_code": "sample string 3", "job_type_id": "f63f5a59-e037-4c46-9594-7fdf3737ba9b", "job_type_code": "sample string 5", "equipment_family_id": "763dea59-8e72-4b11-8871-755aafe6a651", "equipment_family_code": "sample string 7", "skill_ids": [ "20b195e3-5071-440b-969e-840401cc6924", "53a49754-5f91-4b52-abd1-fbb64f03ffa4" ], "skill_codes": [ "sample string 1", "sample string 2" ], "name": "sample string 8", "description": "sample string 9", "estimated_work_time": 10, "additional_information": "sample string 11", "reference_back_office": "sample string 12", "is_required": true, "is_archived": true, "modified_dateutc": "2025-06-07T06:16:06.7209621+00:00" }