Retrieves the work instruction with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

work_instruction
NameDescriptionTypeAdditional 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

Sample:
{
  "id": "139f0956-bd2f-4bc8-a11b-d7e488eeb31b",
  "sales_organization_id": "603a819c-46a5-4c8f-9449-568ed5c5e0bf",
  "sales_organization_code": "sample string 3",
  "job_type_id": "4bb099bc-8600-4088-9d88-98c5faea0fc3",
  "job_type_code": "sample string 5",
  "equipment_family_id": "cf1fae75-ae64-4b14-97a7-98c75e1ad295",
  "equipment_family_code": "sample string 7",
  "skill_ids": [
    "63bf31a9-469e-48f4-96c1-37b0ddcf7ae5",
    "b259e619-f721-4afe-ad69-a81dc3d92829"
  ],
  "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": "2024-05-24T08:06:02.5161141+00:00"
}