Retrieves the work instruction with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The work instruction id.

 globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the work instruction, or 404 Not Found if it doesn't exist.

work_instruction
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
job_type_id

Job type

 globally unique identifier
skill_id

Skill

 globally unique identifier
name

Name of the work instruction

 string
description

Work description

 string
additional_information

Additional info

 string
equipment_family_id

Equipment family

 globally unique identifier
filter_on_job_type

Filter on job type

 boolean
filter_on_equipment_family

Filter on equipment family

 boolean
estimated_work_time

Estimated working time

 integer
sys_has_skills

Check skill

 boolean
reference_back_office

Ref back office

 string
sales_organization_id

Sale organization id

 globally unique identifier
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date
is_required

is_required flag

 boolean
is_archived

is_archived flag

 boolean

Response Formats

application/json, text/json

Sample: 
{
  "id": "ed4034a6-6502-44ad-8e2a-bfe13ddfab76",
  "job_type_id": "405b2368-10b4-4db8-8520-e099d09c1c53",
  "skill_id": "53528ecc-2d4a-4caf-adaa-051b7ef62480",
  "name": "sample string 4",
  "description": "sample string 5",
  "additional_information": "sample string 6",
  "equipment_family_id": "7212ca1a-2814-40e3-90c6-ece8cb92f582",
  "filter_on_job_type": true,
  "filter_on_equipment_family": true,
  "estimated_work_time": 10,
  "sys_has_skills": true,
  "reference_back_office": "sample string 12",
  "sales_organization_id": "b2cc4e29-135a-4902-8f10-49ad1940fb1f",
  "modified_dateutc": "2026-09-16T11:04:37.2688819+00:00",
  "is_required": true,
  "is_archived": true
}

application/xml, text/xml

Sample: 
<work_instruction xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <additional_information>sample string 6</additional_information>
  <description>sample string 5</description>
  <equipment_family_id>7212ca1a-2814-40e3-90c6-ece8cb92f582</equipment_family_id>
  <estimated_work_time>10</estimated_work_time>
  <filter_on_equipment_family>true</filter_on_equipment_family>
  <filter_on_job_type>true</filter_on_job_type>
  <id>ed4034a6-6502-44ad-8e2a-bfe13ddfab76</id>
  <is_archived>true</is_archived>
  <is_required>true</is_required>
  <job_type_id>405b2368-10b4-4db8-8520-e099d09c1c53</job_type_id>
  <modified_dateutc>2026-09-16T11:04:37.268Z</modified_dateutc>
  <name>sample string 4</name>
  <reference_back_office>sample string 12</reference_back_office>
  <sales_organization_id>b2cc4e29-135a-4902-8f10-49ad1940fb1f</sales_organization_id>
  <skill_id>53528ecc-2d4a-4caf-adaa-051b7ef62480</skill_id>
  <sys_has_skills>true</sys_has_skills>
</work_instruction>