API

Production APIs

GET production/resource-categories/{productionResourceCategoryId}/work-order-operations?includeSubCategories={includeSubCategories}&subCategoryName={subCategoryName}

A list of work order operations for given production resource category

HTTP method GET
URI https://api.rambase.net/production/resource-categories/{productionResourceCategoryId}/work-order-operations?includeSubCategories={includeSubCategories}&subCategoryName={subCategoryName}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionResourceCategoryId} Production resource category identifier
Integer, minimum 100000
Maximum page size ($top) 60
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 5202, version 14

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 are 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.

includeSubCategories Boolean, optional A flag to include all production resources also for production resource category's subcategories

Default: False
subCategoryName String, optional Name of subcategory of production resource category to filter down list of work order operations
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Active work order operations
All() Named filter All work order operations
CanBeGrouped() Named filter Work order operations which can be grouped
Completed() Named filter Completed work order operations
Grouped() Named filter Work order operations which have been grouped
MyTasks() Named filter Work order operations for current users
NotGrouped() Named filter Work order operations which have not been grouped
Production() Named filter Work order operations in production
Ready() Named filter Ready work order operations
Wait() Named filter Waiting work order operations
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), 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: now(), startOfDay(), endOfDay(), currentDate(), 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: now(), startOfDay(), endOfDay(), currentDate(), 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: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductionResourceId Integer Production resource identifier.
ProductionWorkOrderId Integer Production work order identifier.
ProductName String Name of the product.
ProductStructureMaterialProductName String Product structure material's product name Name of the operation for operation lines.
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: now(), startOfDay(), endOfDay(), currentDate(), 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: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer Production work order operation status.
WorkOrderOperationGroupId Integer Work order operation group identifier.
WorkOrderOperationId Integer Production work order operation identifier.

Read more 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.
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductionResourceId Integer Production resource identifier
ProductionWorkOrderId Integer Production work order identifier
ProductName String Name of the product
ProductStructureMaterialProductName String Product structure material's product name Name of the operation for operation lines.
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 Production work order operation status
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
          <MaterialDeliveries
MaterialDeliveries

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.MaterialDeliveries in your request URI to get this field

>
9
               <OutsourcedOperations
OutsourcedOperations

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.MaterialDeliveries in your request URI to get this field

>
10
                    <Stock
Stock

Quantity of received product units for external operation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.MaterialDeliveries in your request URI to get this field

>{Integer}</Stock>
11
                    <Total
Total

Quantity of total product units for external operation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.MaterialDeliveries in your request URI to get this field

>{Integer}</Total>
12
               </OutsourcedOperations>
13
          </MaterialDeliveries>
14
          <LatestThreeProductionTasks
LatestThreeProductionTasks

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

>
15
               <Task
Task

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

>
16
                    <TaskId
TaskId

Unique task identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

>{Integer}</TaskId>
17
                    <Type
Type

The type of the task

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

>{String}</Type>
18
                    <Title
Title

The title/summary of the task

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

>{String}</Title>
19
                    <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

>{Datetime}</CreatedAt>
20
                    <Status
Status

The status of a task

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

>{Integer}</Status>
21
                    <Priority
Priority

The priority of the task.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

>{Integer}</Priority>
22
                    <TaskLink
TaskLink

Task reference

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

>{String}</TaskLink>
23
               </Task>
24
          </LatestThreeProductionTasks>
25
          <LatestThreePreProductionTasks
LatestThreePreProductionTasks

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

>
26
               <Task
Task

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

>
27
                    <TaskId
TaskId

Unique task identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

>{Integer}</TaskId>
28
                    <Type
Type

The type of the task

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

>{String}</Type>
29
                    <Title
Title

The title/summary of the task

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

>{String}</Title>
30
                    <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

>{Datetime}</CreatedAt>
31
                    <Status
Status

The status of a task

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

>{Integer}</Status>
32
                    <Priority
Priority

The priority of the task.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

>{Integer}</Priority>
33
                    <TaskLink
TaskLink

Task reference

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

>{String}</TaskLink>
34
               </Task>
35
          </LatestThreePreProductionTasks>
36
          <ProductStructureMaterial
ProductStructureMaterial

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

>
37
               <ProductStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

>{Integer}</ProductStructureMaterialId>
38
               <Quantity
Quantity

Needed material/part quantity in one unit of the product.|

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

>{Decimal}</Quantity>
39
               <Product
Product

The product this structure is valid for

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

>
40
                    <ProductId
ProductId

Product identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

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

Name of the product

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

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

Description of the product

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

>{String}</Description>
43
                    <Type
Type

Type of product

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

>{String}</Type>
44
                    <ProductLink
ProductLink

Product identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

>{String}</ProductLink>
45
               </Product>
46
          </ProductStructureMaterial>
47
          <PlannedOperation>
48
               <PlannedOperationId
PlannedOperationId

Planned work order operation identifier

>{Integer}</PlannedOperationId>
49
               <IsOperationLocked
IsOperationLocked

Is locked, must not be moved. Can be due to inspection by external source.

>{Boolean}</IsOperationLocked>
50
               <PlannedOperationLink
PlannedOperationLink

Planned work order operation reference

>{String}</PlannedOperationLink>
51
          </PlannedOperation>
52
          <WorkOrderOperation>
53
               <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

Production work order operation status

Possible domain values can be found here

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

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

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

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

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

Date and time work order operation actually started

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

Date and time of completion

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

Date and time quetime is completed

>{Datetime}</WaitTimeEndsAt>
60
               <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>
61
               <IsPaused
IsPaused

True if work order operation is paused

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

Flag which indicates if Work Order Operation has been prioritized

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

Quantity of the work order operation

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

A flag indicating if work order operation can be grouped

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

Picking status of work order operation

Possible domain values can be found here

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

Critical days

>{Integer}</PlannedStartAtMargin>
67
               <Processing>
68
                    <IsProcessingCompleted
IsProcessingCompleted

True if processing is completed

>{Boolean}</IsProcessingCompleted>
69
                    <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>
70
                    <RunTime
RunTime

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

>{Decimal}</RunTime>
71
               </Processing>
72
               <Changeover>
73
                    <IsSetupCompleted
IsSetupCompleted

True if setup changeover is completed

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

Time in hours used for setup changeover

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

True if cleanup changeover is completed

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

Time in hours used for cleanup changeover

>{Decimal}</CleanupTime>
77
               </Changeover>
78
               <OnHold>
79
                    <IsOnHold
IsOnHold

True if work order operation is on hold

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

Date and time work order operation was set on hold

>{Datetime}</OnHoldAt>
81
                    <OnHoldTo
OnHoldTo

Date and time work order operation should be on hold to

>{Datetime}</OnHoldTo>
82
                    <Category
Category

A category of work order operation on hold reason

Possible domain values can be found here

>{Integer}</Category>
83
                    <Reason
Reason

Reason for setting work order operation on hold

>{String}</Reason>
84
               </OnHold>
85
               <ProductionWorkOrder>
86
                    <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
87
                    <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>
88
                    <RequestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

>{Date}</RequestedCompletionDate>
89
                    <ConfirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

>{Date}</ConfirmedCompletionDate>
90
                    <ProductRevision
ProductRevision

Product revision used for this production work order

>{String}</ProductRevision>
91
                    <OnHold>
92
                         <IsOnHold
IsOnHold

Flag to indicate if production work order is on hold

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

Date of putting production work order on hold

>{Datetime}</OnHoldAt>
94
                         <OnHoldTo
OnHoldTo

Date and time production work order should be on hold to

>{Datetime}</OnHoldTo>
95
                         <Category
Category

A category of production work order on hold reason

Possible domain values can be found here

>{Integer}</Category>
96
                         <Reason
Reason

Reason of putting production work order on hold

>{String}</Reason>
97
                    </OnHold>
98
                    <ProductionFor>
99
                         <Database
Database

Database of the object

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

Item-number of the object

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

Type of item

>{String}</ItemType>
102
                         <Object>
103
                              <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
105
                              <Customer>
106
                                   <CustomerId
CustomerId

Customer identifier

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

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

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

Customer reference

>{String}</CustomerLink>
109
                              </Customer>
110
                              <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
111
                         </Object>
112
                         <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
114
                    </ProductionFor>
115
                    <Product>
116
                         <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

>{String}</ProductLink>
120
                    </Product>
121
                    <SalesDeliveryProject
SalesDeliveryProject

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.SalesDeliveryProject in your request URI to get this field

>
122
                         <SalesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.SalesDeliveryProject in your request URI to get this field

>{Integer}</SalesDeliveryProjectId>
123
                         <Name
Name

Name of sales delivery

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.SalesDeliveryProject in your request URI to get this field

>{String}</Name>
124
                         <SalesDeliveryProjectLink
SalesDeliveryProjectLink

Sales delivery project reference

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.SalesDeliveryProject in your request URI to get this field

>{String}</SalesDeliveryProjectLink>
125
                    </SalesDeliveryProject>
126
                    <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>
127
               </ProductionWorkOrder>
128
               <ProductStructureOperation>
129
                    <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

>{Integer}</ProductStructureOperationId>
130
                    <SequenceNumber
SequenceNumber

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

>{Integer}</SequenceNumber>
131
                    <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>
132
                    <NoteToOperator
NoteToOperator

Operation information to operator

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductStructureOperation.NoteToOperator in your request URI to get this field

>{String}</NoteToOperator>
133
                    <Changeover>
134
                         <SetupTime
SetupTime

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

>{Decimal}</CleanupTime>
136
                    </Changeover>
137
                    <ProductionOperation>
138
                         <ProductionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

>{String}</ProductionOperationLink>
141
                    </ProductionOperation>
142
                    <ProductionResource>
143
                         <ProductionResourceId
ProductionResourceId

Production resource identifier

>{Integer}</ProductionResourceId>
144
                         <Name
Name

Name of production resource

>{String}</Name>
145
                         <Condition>
146
                              <Code
Code

A number which indicates production resource state, 0=OK, 10=warning, 20=stopped

Possible domain values can be found here

>{Integer}</Code>
147
                              <Note
Note

A description which explains a reason for setting production resource state

>{String}</Note>
148
                         </Condition>
149
                         <ProductionResourceLink
ProductionResourceLink

Production resource reference

>{String}</ProductionResourceLink>
150
                    </ProductionResource>
151
                    <ProductStructureVersion>
152
                         <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

>{Integer}</ProductStructureVersionId>
153
                         <ProductStructureVersionLink
ProductStructureVersionLink

Product structure reference

>{String}</ProductStructureVersionLink>
154
                    </ProductStructureVersion>
155
               </ProductStructureOperation>
156
               <LatestOperator>
157
                    <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
161
               </LatestOperator>
162
               <NumberOfScheduledTaskProcesses
NumberOfScheduledTaskProcesses

Number of scheduled production task processes for work order operation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.NumberOfScheduledTaskProcesses in your request URI to get this field

>{Integer}</NumberOfScheduledTaskProcesses>
163
               <WorkOrderOperationGroup>
164
                    <WorkOrderOperationGroupId
WorkOrderOperationGroupId

Work order operation group identifier

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

Name of Work Order Operation Group

>{String}</Name>
166
                    <Type
Type

Type of work order operation group

Possible domain values can be found here

>{String}</Type>
167
                    <CreatedAt
CreatedAt

Creation date for Group Work Order Operation

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

Work order operation group's reference

>{String}</WorkOrderOperationGroupLink>
169
               </WorkOrderOperationGroup>
170
               <WorkOrderOperationLink
WorkOrderOperationLink

Work order operation reference

>{String}</WorkOrderOperationLink>
171
          </WorkOrderOperation>
172
     </ResourceWorkOrderOperation>
173
     <Paging
Paging

Detailed paging information for this list.

>
174
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
175
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
176
          <Page
Page

Page index

>{Integer}</Page>
177
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
178
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
179
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
180
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
181
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
182
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
183
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
184
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
185
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
186
     </Paging>
187
</ResourceWorkOrderOperations>
1
{
2
     "resourceWorkOrderOperations": [
3
          {
4
               "latestWorkOrderProductOperation": {
5
                    "productUnit": {
6
                         "serialNumber
SerialNumber

Serial number of the product unit

": "{String}"
7
                    }
8
               },
9
               "materialDeliveries
MaterialDeliveries

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.MaterialDeliveries in your request URI to get this field

": {
10
                    "outsourcedOperations
OutsourcedOperations

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.MaterialDeliveries in your request URI to get this field

": {
11
                         "stock
Stock

Quantity of received product units for external operation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.MaterialDeliveries in your request URI to get this field

": "{Integer}",
12
                         "total
Total

Quantity of total product units for external operation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.MaterialDeliveries in your request URI to get this field

": "{Integer}"
13
                    }
14
               },
15
               "latestThreeProductionTasks
LatestThreeProductionTasks

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

": [
16
                    {
17
                         "taskId
TaskId

Unique task identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

": "{Integer}",
18
                         "type
Type

The type of the task

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

": "{String}",
19
                         "title
Title

The title/summary of the task

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

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

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

": "{Datetime}",
21
                         "status
Status

The status of a task

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

": "{Integer}",
22
                         "priority
Priority

The priority of the task.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

": "{Integer}",
23
                         "taskLink
TaskLink

Task reference

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreeProductionTasks in your request URI to get this field

": "{String}"
24
                    }
25
               ],
26
               "latestThreePreProductionTasks
LatestThreePreProductionTasks

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

": [
27
                    {
28
                         "taskId
TaskId

Unique task identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

": "{Integer}",
29
                         "type
Type

The type of the task

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

": "{String}",
30
                         "title
Title

The title/summary of the task

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

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

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

": "{Datetime}",
32
                         "status
Status

The status of a task

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

": "{Integer}",
33
                         "priority
Priority

The priority of the task.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

": "{Integer}",
34
                         "taskLink
TaskLink

Task reference

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.LatestThreePreProductionTasks in your request URI to get this field

": "{String}"
35
                    }
36
               ],
37
               "productStructureMaterial
ProductStructureMaterial

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

": {
38
                    "productStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

": "{Integer}",
39
                    "quantity
Quantity

Needed material/part quantity in one unit of the product.|

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

": "{Decimal}",
40
                    "product
Product

The product this structure is valid for

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

": {
41
                         "productId
ProductId

Product identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

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

Name of the product

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

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

Description of the product

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

": "{String}",
44
                         "type
Type

Type of product

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

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

Product identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.ProductStructureMaterial in your request URI to get this field

": "{String}"
46
                    }
47
               },
48
               "plannedOperation": {
49
                    "plannedOperationId
PlannedOperationId

Planned work order operation identifier

": "{Integer}",
50
                    "isOperationLocked
IsOperationLocked

Is locked, must not be moved. Can be due to inspection by external source.

": "{Boolean}",
51
                    "plannedOperationLink
PlannedOperationLink

Planned work order operation reference

": "{String}"
52
               },
53
               "workOrderOperation": {
54
                    "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

Production work order operation status

Possible domain values can be found here

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

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

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

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

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

Date and time work order operation actually started

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

Date and time of completion

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

Date and time quetime is completed

": "{Datetime}",
61
                    "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}",
62
                    "isPaused
IsPaused

True if work order operation is paused

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

Flag which indicates if Work Order Operation has been prioritized

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

Quantity of the work order operation

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

A flag indicating if work order operation can be grouped

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

Picking status of work order operation

Possible domain values can be found here

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

Critical days

": "{Integer}",
68
                    "processing": {
69
                         "isProcessingCompleted
IsProcessingCompleted

True if processing is completed

": "{Boolean}",
70
                         "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}",
71
                         "runTime
RunTime

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

": "{Decimal}"
72
                    },
73
                    "changeover": {
74
                         "isSetupCompleted
IsSetupCompleted

True if setup changeover is completed

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

Time in hours used for setup changeover

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

True if cleanup changeover is completed

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

Time in hours used for cleanup changeover

": "{Decimal}"
78
                    },
79
                    "onHold": {
80
                         "isOnHold
IsOnHold

True if work order operation is on hold

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

Date and time work order operation was set on hold

": "{Datetime}",
82
                         "onHoldTo
OnHoldTo

Date and time work order operation should be on hold to

": "{Datetime}",
83
                         "category
Category

A category of work order operation on hold reason

Possible domain values can be found here

": "{Integer}",
84
                         "reason
Reason

Reason for setting work order operation on hold

": "{String}"
85
                    },
86
                    "productionWorkOrder": {
87
                         "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

": "{Integer}",
88
                         "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}",
89
                         "requestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

": "{Date}",
90
                         "confirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

": "{Date}",
91
                         "productRevision
ProductRevision

Product revision used for this production work order

": "{String}",
92
                         "onHold": {
93
                              "isOnHold
IsOnHold

Flag to indicate if production work order is on hold

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

Date of putting production work order on hold

": "{Datetime}",
95
                              "onHoldTo
OnHoldTo

Date and time production work order should be on hold to

": "{Datetime}",
96
                              "category
Category

A category of production work order on hold reason

Possible domain values can be found here

": "{Integer}",
97
                              "reason
Reason

Reason of putting production work order on hold

": "{String}"
98
                         },
99
                         "productionFor": {
100
                              "database
Database

Database of the object

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

Item-number of the object

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

Type of item

": "{String}",
103
                              "object": {
104
                                   "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
106
                                   "customer": {
107
                                        "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

": "{String}"
110
                                   },
111
                                   "objectLink
ObjectLink

API reference to the object

": "{String}"
112
                              },
113
                              "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}"
115
                         },
116
                         "product": {
117
                              "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Product reference

": "{String}"
121
                         },
122
                         "salesDeliveryProject
SalesDeliveryProject

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.SalesDeliveryProject in your request URI to get this field

": {
123
                              "salesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.SalesDeliveryProject in your request URI to get this field

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

Name of sales delivery

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.SalesDeliveryProject in your request URI to get this field

": "{String}",
125
                              "salesDeliveryProjectLink
SalesDeliveryProjectLink

Sales delivery project reference

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductionWorkOrder.SalesDeliveryProject in your request URI to get this field

": "{String}"
126
                         },
127
                         "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

": "{String}"
128
                    },
129
                    "productStructureOperation": {
130
                         "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

": "{Integer}",
131
                         "sequenceNumber
SequenceNumber

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

": "{Integer}",
132
                         "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}",
133
                         "noteToOperator
NoteToOperator

Operation information to operator

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.ProductStructureOperation.NoteToOperator in your request URI to get this field

": "{String}",
134
                         "changeover": {
135
                              "setupTime
SetupTime

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

": "{Decimal}"
137
                         },
138
                         "productionOperation": {
139
                              "productionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

": "{String}"
142
                         },
143
                         "productionResource": {
144
                              "productionResourceId
ProductionResourceId

Production resource identifier

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

Name of production resource

": "{String}",
146
                              "condition": {
147
                                   "code
Code

A number which indicates production resource state, 0=OK, 10=warning, 20=stopped

Possible domain values can be found here

": "{Integer}",
148
                                   "note
Note

A description which explains a reason for setting production resource state

": "{String}"
149
                              },
150
                              "productionResourceLink
ProductionResourceLink

Production resource reference

": "{String}"
151
                         },
152
                         "productStructureVersion": {
153
                              "productStructureVersionId
ProductStructureVersionId

Product structure identifier

": "{Integer}",
154
                              "productStructureVersionLink
ProductStructureVersionLink

Product structure reference

": "{String}"
155
                         }
156
                    },
157
                    "latestOperator": {
158
                         "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
162
                    },
163
                    "numberOfScheduledTaskProcesses
NumberOfScheduledTaskProcesses

Number of scheduled production task processes for work order operation

This field is greyed out because it is an expandable field. You have to add $expand=ResourceWorkOrderOperation.WorkOrderOperation.NumberOfScheduledTaskProcesses in your request URI to get this field

": "{Integer}",
164
                    "workOrderOperationGroup": {
165
                         "workOrderOperationGroupId
WorkOrderOperationGroupId

Work order operation group identifier

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

Name of Work Order Operation Group

": "{String}",
167
                         "type
Type

Type of work order operation group

Possible domain values can be found here

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

Creation date for Group Work Order Operation

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

Work order operation group's reference

": "{String}"
170
                    },
171
                    "workOrderOperationLink
WorkOrderOperationLink

Work order operation reference

": "{String}"
172
               }
173
          }
174
     ],
175
     "paging
Paging

Detailed paging information for this list.

": {
176
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
177
          "position
Position

Position of the first element in the list

": "{Integer}",
178
          "page
Page

Page index

": "{Integer}",
179
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
180
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
181
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
182
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
183
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
184
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
185
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
186
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
187
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
188
     }
189
}

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 101030 HTTP 404 Role not found
Error 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required