Retrieves all work instructions, optionally filtered via OData query options.
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the list of work instructions.
work_instruction| Name | Description | Type | Additional 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": "36aefabd-b4df-4bd8-834b-f5cd5774d257",
"job_type_id": "04d1e954-4f84-4814-93fe-4da27b83514b",
"skill_id": "4260c1ee-507a-42cd-a27a-b8a1de87b51c",
"name": "sample string 4",
"description": "sample string 5",
"additional_information": "sample string 6",
"equipment_family_id": "ffc8a08f-9261-416e-9738-e79be1eef559",
"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": "a196db3d-2bc5-403f-b819-41c29ae7eaeb",
"modified_dateutc": "2026-11-12T14:27:52.8062677+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>ffc8a08f-9261-416e-9738-e79be1eef559</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>36aefabd-b4df-4bd8-834b-f5cd5774d257</id> <is_archived>true</is_archived> <is_required>true</is_required> <job_type_id>04d1e954-4f84-4814-93fe-4da27b83514b</job_type_id> <modified_dateutc>2026-11-12T14:27:52.806Z</modified_dateutc> <name>sample string 4</name> <reference_back_office>sample string 12</reference_back_office> <sales_organization_id>a196db3d-2bc5-403f-b819-41c29ae7eaeb</sales_organization_id> <skill_id>4260c1ee-507a-42cd-a27a-b8a1de87b51c</skill_id> <sys_has_skills>true</sys_has_skills> </work_instruction>