GET production/resources/{productionResourceId}/work-order-operations

Resource for retrieving list of work orders in given production resource

Note: Log in to check if your API client have access to run this resource
Version: 48
Success HTTP Status Code: 200
Maximum items from list ($top): 80

Uri parameters

{productionResourceId} Integer Production resource identifier

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Status of production work order operation
All() Named filter Status of production work order operation
CanBeGrouped() Named filter Check if work order operation can be grouped
Completed() Named filter Status of production work order operation
Grouped() Named filter Check if work order operation has been grouped
MyTasks() Named filter Production work order operations for current user
NotGrouped() Named filter Check if work order operation is not grouped
Production() Named filter Status of production work order operation
Ready() Named filter Status of production work order operation
Wait() Named filter Status of production work order operation
CreatedAt Datetime Date and time of creation. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomersReferenceNumber String Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.
FinishedAt Datetime Date and time of completion. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
HasPriority Boolean Flag which indicates if Work Order Operation has been prioritized.
IsOnHold Boolean True if work order operation is on hold.
IsPaused Boolean True if work order operation is paused.
LatestOperatorId Integer Employee identifier. Available macros: currentUser()
Operation String Name of the operation.
PlannedFinishedAt Datetime Date and time planned to finish. Specified by the planned work order operation.. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
PlannedStartAt Datetime Date and time planned to start. Specified by the planned work order operation.. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ProductId Integer Product identifier.
ProductionWorkOrderId Integer Production work order identifier.
ProductName String Name of the product.
ProductUnitId Integer Product unit identifier.
Quantity Decimal Quantity of the work order operation.
ReadyAt Datetime Earliest date and time for starting the work order operation. This is typically when the previous operation was completed. Comparing EarliestStartAt with StartedAt might give insight for improvements. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SerialNumber String Serial number of the product unit.
StartedAt Datetime Date and time work order operation actually started. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer Status of production work order operation.
WorkOrderOperationGroupId Integer Work order operation group identifier.
WorkOrderOperationId Integer Production work order operation identifier.

See the page about filters and sorting on how to use sortable parameters

CreatedAt Datetime Date and time of creation
CustomersReferenceNumber String Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.
FinishedAt Datetime Date and time of completion
HasPriority Boolean Flag which indicates if Work Order Operation has been prioritized
IsOnHold Boolean True if work order operation is on hold
IsPaused Boolean True if work order operation is paused
LatestOperatorId Integer Employee identifier
Operation String Name of the operation
PlannedFinishedAt Datetime Date and time planned to finish. Specified by the planned work order operation.
PlannedStartAt Datetime Date and time planned to start. Specified by the planned work order operation.
ProductId Integer Product identifier
ProductionWorkOrderId Integer Production work order identifier
ProductName String Name of the product
Quantity Decimal Quantity of the work order operation
ReadyAt Datetime Earliest date and time for starting the work order operation. This is typically when the previous operation was completed. Comparing EarliestStartAt with StartedAt might give insight for improvements.
StartedAt Datetime Date and time work order operation actually started
Status Integer Status of production work order operation
WorkOrderOperationGroupId Integer Work order operation group identifier
WorkOrderOperationId Integer Production work order operation identifier

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ResourceWorkOrderOperations>
2
     <ResourceWorkOrderOperation>
3
          <LatestWorkOrderProductOperation>
4
               <ProductUnit>
5
                    <SerialNumber
SerialNumber

Serial number of the product unit

>
{String}</SerialNumber>
6
               </ProductUnit>
7
          </LatestWorkOrderProductOperation>
8
          <WorkOrderOperation>
9
               <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

>
{Integer}</WorkOrderOperationId>
10
               <Status
Status

Status of production work order operation

Possible domain values can be found here when logged in

>
{Integer}</Status>
11
               <PlannedStartAt
PlannedStartAt

Date and time planned to start. Specified by the planned work order operation.

>
{Datetime}</PlannedStartAt>
12
               <PlannedFinishedAt
PlannedFinishedAt

Date and time planned to finish. Specified by the planned work order operation.

>
{Datetime}</PlannedFinishedAt>
13
               <StartedAt
StartedAt

Date and time work order operation actually started

>
{Datetime}</StartedAt>
14
               <FinishedAt
FinishedAt

Date and time of completion

>
{Datetime}</FinishedAt>
15
               <WaitTimeEndsAt
WaitTimeEndsAt

Date and time quetime is completed

>
{Datetime}</WaitTimeEndsAt>
16
               <ReadyAt
ReadyAt

Earliest date and time for starting the work order operation. This is typically when the previous operation was completed. Comparing EarliestStartAt with StartedAt might give insight for improvements.

>
{Datetime}</ReadyAt>
17
               <IsPaused
IsPaused

True if work order operation is paused

>
{Boolean}</IsPaused>
18
               <HasPriority
HasPriority

Flag which indicates if Work Order Operation has been prioritized

>
{Boolean}</HasPriority>
19
               <Quantity
Quantity

Quantity of the work order operation

>
{Decimal}</Quantity>
20
               <CanBeGrouped
CanBeGrouped

A flag indicating if work order operation can be grouped

>
{Boolean}</CanBeGrouped>
21
               <PickingStatus
PickingStatus

Picking status of work order operation

Possible domain values can be found here when logged in

>
{Integer}</PickingStatus>
22
               <PlannedStartAtMargin
PlannedStartAtMargin

Critical days

>
{Integer}</PlannedStartAtMargin>
23
               <Processing>
24
                    <IsProcessingCompleted
IsProcessingCompleted

True if processing is completed

>
{Boolean}</IsProcessingCompleted>
25
                    <PlannedRunTime
PlannedRunTime

Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation

>
{Decimal}</PlannedRunTime>
26
                    <RunTime
RunTime

The time required to process a piece or lot at a specific operation. Specified in hours.

>
{Decimal}</RunTime>
27
               </Processing>
28
               <Changeover>
29
                    <IsSetupCompleted
IsSetupCompleted

True if setup changeover is completed

>
{Boolean}</IsSetupCompleted>
30
                    <SetupTime
SetupTime

Time in hours used for setup changeover

>
{Decimal}</SetupTime>
31
                    <IsCleanupCompleted
IsCleanupCompleted

True if cleanup changeover is completed

>
{Boolean}</IsCleanupCompleted>
32
                    <CleanupTime
CleanupTime

Time in hours used for cleanup changeover

>
{Decimal}</CleanupTime>
33
               </Changeover>
34
               <OnHold>
35
                    <IsOnHold
IsOnHold

True if work order operation is on hold

>
{Boolean}</IsOnHold>
36
                    <OnHoldAt
OnHoldAt

Date and time work order operation was set on hold

>
{Datetime}</OnHoldAt>
37
                    <Reason
Reason

Reason for setting work order operation on hold

>
{String}</Reason>
38
               </OnHold>
39
               <ProductionWorkOrder>
40
                    <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>
{Integer}</ProductionWorkOrderId>
41
                    <CustomersReferenceNumber
CustomersReferenceNumber

Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.

>
{String}</CustomersReferenceNumber>
42
                    <ProductRevision
ProductRevision

Product revision used for this production work order

>
{String}</ProductRevision>
43
                    <OnHold>
44
                         <IsOnHold
IsOnHold

Flag to indicate if production work order is on hold

>
{Boolean}</IsOnHold>
45
                         <OnHoldAt
OnHoldAt

Date of putting production work order on hold

>
{Datetime}</OnHoldAt>
46
                         <Reason
Reason

Reason of putting production work order on hold

>
{String}</Reason>
47
                    </OnHold>
48
                    <ProductionFor>
49
                         <Database
Database

Database of the object

>
{String}</Database>
50
                         <ItemId
ItemId

Item-number of the object

>
{Integer}</ItemId>
51
                         <ItemType
ItemType

Type of item

>
{String}</ItemType>
52
                         <Object>
53
                              <ObjectId
ObjectId

Identifier of the object

>
{Integer}</ObjectId>
54
                              <ObjectType
ObjectType

Type of object

>
{String}</ObjectType>
55
                              <Customer>
56
                                   <CustomerId
CustomerId

Customer identifier

>
{Integer}</CustomerId>
57
                                   <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>
{String}</Name>
58
                                   <CustomerLink
CustomerLink

Customer reference

>
{String}</CustomerLink>
59
                              </Customer>
60
                              <ObjectLink
ObjectLink

API reference to the object

>
{String}</ObjectLink>
61
                         </Object>
62
                         <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
{String}</RamBaseKey>
63
                         <ItemLink
ItemLink

API reference to the item

>
{String}</ItemLink>
64
                    </ProductionFor>
65
                    <Product>
66
                         <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
67
                         <Name
Name

Name of the product

>
{String}</Name>
68
                         <Description
Description

Description of the product

>
{String}</Description>
69
                         <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
70
                    </Product>
71
                    <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>
{String}</ProductionWorkOrderLink>
72
               </ProductionWorkOrder>
73
               <ProductStructureOperation>
74
                    <SequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

>
{Integer}</SequenceNumber>
75
                    <WaitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

>
{Decimal}</WaitTime>
76
                    <Changeover>
77
                         <SetupTime
SetupTime

Changeover pre/setup time in hours

>
{Decimal}</SetupTime>
78
                         <CleanupTime
CleanupTime

Changeover post/cleanup time in hours

>
{Decimal}</CleanupTime>
79
                    </Changeover>
80
                    <ProductionOperation>
81
                         <ProductionOperationId
ProductionOperationId

Production operation identifier

>
{Integer}</ProductionOperationId>
82
                         <Name
Name

Name of production operation

>
{String}</Name>
83
                         <ProductionOperationLink
ProductionOperationLink

Production operation reference

>
{String}</ProductionOperationLink>
84
                    </ProductionOperation>
85
               </ProductStructureOperation>
86
               <LatestOperator>
87
                    <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
88
                    <LastName
LastName

Last name of employee

>
{String}</LastName>
89
                    <FirstName
FirstName

First name of employee

>
{String}</FirstName>
90
                    <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
91
               </LatestOperator>
92
               <WorkOrderOperationGroup>
93
                    <WorkOrderOperationGroupId
WorkOrderOperationGroupId

Work order operation group identifier

>
{Integer}</WorkOrderOperationGroupId>
94
                    <Name
Name

Name of Work Order Operation Group

>
{String}</Name>
95
                    <CreatedAt
CreatedAt

Creation date for Group Work Order Operation

>
{Date}</CreatedAt>
96
                    <WorkOrderOperationGroupLink
WorkOrderOperationGroupLink

Work order operation group's reference

>
{String}</WorkOrderOperationGroupLink>
97
               </WorkOrderOperationGroup>
98
               <WorkOrderOperationLink
WorkOrderOperationLink

Work order operation reference

>
{String}</WorkOrderOperationLink>
99
          </WorkOrderOperation>
100
     </ResourceWorkOrderOperation>
101
</ResourceWorkOrderOperations>
1
{
2
     "resourceWorkOrderOperations": [
3
          {
4
               "latestWorkOrderProductOperation": {
5
                    "productUnit": {
6
                         "serialNumber
SerialNumber

Serial number of the product unit

":
"{String}"
7
                    }
8
               },
9
               "workOrderOperation": {
10
                    "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

":
"{Integer}",
11
                    "status
Status

Status of production work order operation

Possible domain values can be found here when logged in

":
"{Integer}",
12
                    "plannedStartAt
PlannedStartAt

Date and time planned to start. Specified by the planned work order operation.

":
"{Datetime}",
13
                    "plannedFinishedAt
PlannedFinishedAt

Date and time planned to finish. Specified by the planned work order operation.

":
"{Datetime}",
14
                    "startedAt
StartedAt

Date and time work order operation actually started

":
"{Datetime}",
15
                    "finishedAt
FinishedAt

Date and time of completion

":
"{Datetime}",
16
                    "waitTimeEndsAt
WaitTimeEndsAt

Date and time quetime is completed

":
"{Datetime}",
17
                    "readyAt
ReadyAt

Earliest date and time for starting the work order operation. This is typically when the previous operation was completed. Comparing EarliestStartAt with StartedAt might give insight for improvements.

":
"{Datetime}",
18
                    "isPaused
IsPaused

True if work order operation is paused

":
"{Boolean}",
19
                    "hasPriority
HasPriority

Flag which indicates if Work Order Operation has been prioritized

":
"{Boolean}",
20
                    "quantity
Quantity

Quantity of the work order operation

":
"{Decimal}",
21
                    "canBeGrouped
CanBeGrouped

A flag indicating if work order operation can be grouped

":
"{Boolean}",
22
                    "pickingStatus
PickingStatus

Picking status of work order operation

Possible domain values can be found here when logged in

":
"{Integer}",
23
                    "plannedStartAtMargin
PlannedStartAtMargin

Critical days

":
"{Integer}",
24
                    "processing": {
25
                         "isProcessingCompleted
IsProcessingCompleted

True if processing is completed

":
"{Boolean}",
26
                         "plannedRunTime
PlannedRunTime

Planned runtime of the work order operation. Calculated by multiplying the quantity of the work order operation by the runtime of the product structure operation

":
"{Decimal}",
27
                         "runTime
RunTime

The time required to process a piece or lot at a specific operation. Specified in hours.

":
"{Decimal}"
28
                    },
29
                    "changeover": {
30
                         "isSetupCompleted
IsSetupCompleted

True if setup changeover is completed

":
"{Boolean}",
31
                         "setupTime
SetupTime

Time in hours used for setup changeover

":
"{Decimal}",
32
                         "isCleanupCompleted
IsCleanupCompleted

True if cleanup changeover is completed

":
"{Boolean}",
33
                         "cleanupTime
CleanupTime

Time in hours used for cleanup changeover

":
"{Decimal}"
34
                    },
35
                    "onHold": {
36
                         "isOnHold
IsOnHold

True if work order operation is on hold

":
"{Boolean}",
37
                         "onHoldAt
OnHoldAt

Date and time work order operation was set on hold

":
"{Datetime}",
38
                         "reason
Reason

Reason for setting work order operation on hold

":
"{String}"
39
                    },
40
                    "productionWorkOrder": {
41
                         "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

":
"{Integer}",
42
                         "customersReferenceNumber
CustomersReferenceNumber

Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.

":
"{String}",
43
                         "productRevision
ProductRevision

Product revision used for this production work order

":
"{String}",
44
                         "onHold": {
45
                              "isOnHold
IsOnHold

Flag to indicate if production work order is on hold

":
"{Boolean}",
46
                              "onHoldAt
OnHoldAt

Date of putting production work order on hold

":
"{Datetime}",
47
                              "reason
Reason

Reason of putting production work order on hold

":
"{String}"
48
                         },
49
                         "productionFor": {
50
                              "database
Database

Database of the object

":
"{String}",
51
                              "itemId
ItemId

Item-number of the object

":
"{Integer}",
52
                              "itemType
ItemType

Type of item

":
"{String}",
53
                              "object": {
54
                                   "objectId
ObjectId

Identifier of the object

":
"{Integer}",
55
                                   "objectType
ObjectType

Type of object

":
"{String}",
56
                                   "customer": {
57
                                        "customerId
CustomerId

Customer identifier

":
"{Integer}",
58
                                        "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

":
"{String}",
59
                                        "customerLink
CustomerLink

Customer reference

":
"{String}"
60
                                   },
61
                                   "objectLink
ObjectLink

API reference to the object

":
"{String}"
62
                              },
63
                              "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

":
"{String}",
64
                              "itemLink
ItemLink

API reference to the item

":
"{String}"
65
                         },
66
                         "product": {
67
                              "productId
ProductId

Product identifier

":
"{Integer}",
68
                              "name
Name

Name of the product

":
"{String}",
69
                              "description
Description

Description of the product

":
"{String}",
70
                              "productLink
ProductLink

Product reference

":
"{String}"
71
                         },
72
                         "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

":
"{String}"
73
                    },
74
                    "productStructureOperation": {
75
                         "sequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

":
"{Integer}",
76
                         "waitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

":
"{Decimal}",
77
                         "changeover": {
78
                              "setupTime
SetupTime

Changeover pre/setup time in hours

":
"{Decimal}",
79
                              "cleanupTime
CleanupTime

Changeover post/cleanup time in hours

":
"{Decimal}"
80
                         },
81
                         "productionOperation": {
82
                              "productionOperationId
ProductionOperationId

Production operation identifier

":
"{Integer}",
83
                              "name
Name

Name of production operation

":
"{String}",
84
                              "productionOperationLink
ProductionOperationLink

Production operation reference

":
"{String}"
85
                         }
86
                    },
87
                    "latestOperator": {
88
                         "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
89
                         "lastName
LastName

Last name of employee

":
"{String}",
90
                         "firstName
FirstName

First name of employee

":
"{String}",
91
                         "employeeLink
EmployeeLink

Employee reference

":
"{String}"
92
                    },
93
                    "workOrderOperationGroup": {
94
                         "workOrderOperationGroupId
WorkOrderOperationGroupId

Work order operation group identifier

":
"{Integer}",
95
                         "name
Name

Name of Work Order Operation Group

":
"{String}",
96
                         "createdAt
CreatedAt

Creation date for Group Work Order Operation

":
"{Date}",
97
                         "workOrderOperationGroupLink
WorkOrderOperationGroupLink

Work order operation group's reference

":
"{String}"
98
                    },
99
                    "workOrderOperationLink
WorkOrderOperationLink

Work order operation reference

":
"{String}"
100
               }
101
          }
102
     ]
103
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100207 HTTP 404 Production resource not found
Error 101814 HTTP 404 Employee not found
Error 100241 HTTP 404 Production work order not found
Error 101231 HTTP 404 Production work order item not found
Error 100031 HTTP 404 Customer not found
Error 100089 HTTP 404 Product not found
Error 103366 HTTP 404 Production resource group not found
Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects
Error 101119 HTTP 404 Shipping Service document not found
Error 101304 HTTP 404 Carrier not found
Error 102738 HTTP 404 Price list not found
Error 103263 HTTP 400 Wrong use of sort or table size in SarRead
Error 102270 HTTP 404 WorkOrderOperation not found