API

Production APIs

GET production/work-order-operations

List of all work order operations

HTTP method GET
URI https://api.rambase.net/production/work-order-operations
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2880, version 35

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.

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

MyTasks() Named filter Production work order operations for current user
ChangeoverCleanupTime Decimal Time in hours used for cleanup changeover.
ChangeoverSetupTime Decimal Time in hours used for setup changeover.
CheckpointApprovedAt Datetime Date and time of checkpoint approval. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CheckpointApprovedBy Integer Employee identifier. Available macros: currentUser()
CompletedQuantity Decimal Quantity completed in this work order operation.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
FinishedAt Datetime Date and time of completion. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
IsCleanupCompleted Boolean True if cleanup changeover is completed.
IsOnHold Boolean True if work order operation is on hold.
IsOutsourced Boolean A flag to indicate if production operation is outsourced.
IsPaused Boolean True if work order operation is paused.
IsProcessingCompleted Boolean True if processing is completed.
IsSetupCompleted Boolean True if setup changeover is completed.
LatestOperatorId Integer Employee identifier. Available macros: currentUser()
OnHoldAt Datetime Date and time work order operation was set on hold. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
OnHoldByUserId Integer User identifier.
OperationSequenceNumber Integer Sequence number of the product structure operation. Unique within a product structure.
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()
ProductId Integer Product identifier.
ProductionOperationId Integer Production operation identifier.
ProductionResourceGroupId Integer Production resource group identifier.
ProductionResourceId Integer Production resource identifier.
ProductionWorkOrderId Integer Production work order identifier.
ProductName String Name of the product.
ProductStructureId Integer Product structure identifier.
ProductStructureOperationId Integer Product structure operation identifier.
PurchaseOrderId Integer Purchase order 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()
RunTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
ScrappedQuantity Decimal Quantity of recyclable items left over from work order operation. Note that unlike waste, scrap has monetary value.
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.
UpdatedAt Datetime Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
WorkOrderOperationId Integer Production work order operation identifier.

Read more about filters and sorting on how to use sortable parameters

ChangeoverCleanupTime Decimal Time in hours used for cleanup changeover
ChangeoverSetupTime Decimal Time in hours used for setup changeover
CheckpointApprovedAt Datetime Date and time of checkpoint approval
CheckpointApprovedBy Integer Employee identifier
CompletedQuantity Decimal Quantity completed in this work order operation
CreatedAt Datetime Date and time of creation
FinishedAt Datetime Date and time of completion
IsCleanupCompleted Boolean True if cleanup changeover is completed
IsOnHold Boolean True if work order operation is on hold
IsOutsourced Boolean A flag to indicate if production operation is outsourced
IsPaused Boolean True if work order operation is paused
IsProcessingCompleted Boolean True if processing is completed
IsSetupCompleted Boolean True if setup changeover is completed
LatestOperatorId Integer Employee identifier
OnHoldAt Datetime Date and time work order operation was set on hold
OnHoldByUserId Integer User identifier
OperationSequenceNumber Integer Sequence number of the product structure operation. Unique within a product structure.
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
ProductionOperationId Integer Production operation identifier
ProductionResourceGroupId Integer Production resource group identifier
ProductionResourceId Integer Production resource identifier
ProductionWorkOrderId Integer Production work order identifier
ProductName String Name of the product
ProductStructureId Integer Product structure identifier
ProductStructureOperationId Integer Product structure operation identifier
PurchaseOrderId Integer Purchase order 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.
RunTime Decimal The time required to process a piece or lot at a specific operation. Specified in hours.
ScrappedQuantity Decimal Quantity of recyclable items left over from work order operation. Note that unlike waste, scrap has monetary value.
StartedAt Datetime Date and time work order operation actually started
Status Integer Production work order operation status
UpdatedAt Datetime Date and time of update
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
<WorkOrderOperations>
2
     <WorkOrderOperation>
3
          <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

Production work order operation status

Possible domain values can be found here

>{Integer}</Status>
5
          <ExtendedStatus
ExtendedStatus

Extended Work Order Operation status information

Possible domain values can be found here

>{String}</ExtendedStatus>
6
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
7
          <UpdatedAt
UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>
8
          <PlannedStartAt
PlannedStartAt

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

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

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

>{Datetime}</PlannedFinishedAt>
10
          <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>
11
          <StartedAt
StartedAt

Date and time work order operation actually started

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

Date and time of completion

>{Datetime}</FinishedAt>
13
          <IsPaused
IsPaused

True if work order operation is paused

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

Flag which indicates if Work Order Operation has been prioritized

>{Boolean}</HasPriority>
15
          <WaitTimeEndsAt
WaitTimeEndsAt

Date and time quetime is completed

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

Quantity of the work order operation

>{Decimal}</Quantity>
17
          <ProductPlacement
ProductPlacement

The placement of the product after completed work order operation

>{String}</ProductPlacement>
18
          <AdditionalManHours
AdditionalManHours

Additional labour hours or man hours in this work order operation.

>{Decimal}</AdditionalManHours>
19
          <Processing>
20
               <IsProcessingCompleted
IsProcessingCompleted

True if processing is completed

>{Boolean}</IsProcessingCompleted>
21
               <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>
22
               <RunTime
RunTime

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

>{Decimal}</RunTime>
23
          </Processing>
24
          <Changeover>
25
               <IsSetupCompleted
IsSetupCompleted

True if setup changeover is completed

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

Time in hours used for setup changeover

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

True if cleanup changeover is completed

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

Time in hours used for cleanup changeover

>{Decimal}</CleanupTime>
29
          </Changeover>
30
          <CostOverrun
CostOverrun

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

>
31
               <HasCostOverrun
HasCostOverrun

Flag to indicate if product structure's operation has got cost deviation

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

>{Boolean}</HasCostOverrun>
32
               <ApprovedAmount
ApprovedAmount

Cost overrun approved value

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

>{Decimal}</ApprovedAmount>
33
               <Amount
Amount

Value of product structure's operation cost deviation

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

>{Decimal}</Amount>
34
          </CostOverrun>
35
          <TimeOverrun
TimeOverrun

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

>
36
               <HasTimeOverrun
HasTimeOverrun

Flag to indicate if product structure's operation has got worklog deviation

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

>{Boolean}</HasTimeOverrun>
37
               <Percent
Percent

Percentage value of product structure's operation worklog deviation

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

>{Decimal}</Percent>
38
          </TimeOverrun>
39
          <OnHold>
40
               <IsOnHold
IsOnHold

True if work order operation is on hold

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

Date and time work order operation was set on hold

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

Date and time work order operation should be on hold to

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

A category of work order operation on hold reason

Possible domain values can be found here

>{Integer}</Category>
44
               <CausedBy
CausedBy

A side responsible for causing work order operation on hold

Possible domain values can be found here

>{String}</CausedBy>
45
               <Reason
Reason

Reason for setting work order operation on hold

>{String}</Reason>
46
               <OnHoldBy
OnHoldBy

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

>
47
                    <UserId
UserId

User identifier

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

>{Integer}</UserId>
48
                    <Name
Name

Name of the user

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

>{String}</Name>
49
                    <FirstName
FirstName

First name of the user

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

>{String}</FirstName>
50
                    <UserLink
UserLink

User reference

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

>{String}</UserLink>
51
               </OnHoldBy>
52
          </OnHold>
53
          <ProductionWorkOrder>
54
               <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
55
               <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>
56
               <OnHold>
57
                    <IsOnHold
IsOnHold

Flag to indicate if production work order is on hold

>{Boolean}</IsOnHold>
58
               </OnHold>
59
               <ProductionFor>
60
                    <Database
Database

Database of the object

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

Item-number of the object

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

Type of item

>{String}</ItemType>
63
                    <Object>
64
                         <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
66
                         <Customer>
67
                              <CustomerId
CustomerId

Customer identifier

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

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

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

Customer reference

>{String}</CustomerLink>
70
                         </Customer>
71
                         <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
72
                    </Object>
73
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
75
               </ProductionFor>
76
               <Product>
77
                    <ProductId
ProductId

Product identifier

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

Name of the product

>{String}</Name>
79
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
80
               </Product>
81
               <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>
82
          </ProductionWorkOrder>
83
          <ProductStructureOperation>
84
               <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

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

>{Integer}</SequenceNumber>
86
               <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>
87
               <Processing>
88
                    <RunTime
RunTime

Runtime of the product structure operation. Changeover time is not included here.

>{Decimal}</RunTime>
89
               </Processing>
90
               <Changeover>
91
                    <SetupTime
SetupTime

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

>{Decimal}</CleanupTime>
93
               </Changeover>
94
               <ProductionOperation>
95
                    <ProductionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

>{String}</ProductionOperationLink>
98
               </ProductionOperation>
99
               <ProductionResource>
100
                    <ProductionResourceId
ProductionResourceId

Production resource identifier

>{Integer}</ProductionResourceId>
101
                    <AllowMultipleOperators
AllowMultipleOperators

True if multiple operators can work with one work order operation.

>{Boolean}</AllowMultipleOperators>
102
                    <Name
Name

Name of production resource

>{String}</Name>
103
                    <ProductionResourceLink
ProductionResourceLink

Production resource reference

>{String}</ProductionResourceLink>
104
               </ProductionResource>
105
               <ProductionResourceGroup>
106
                    <ProductionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

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

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

Production resource group reference

>{String}</ProductionResourceGroupLink>
109
               </ProductionResourceGroup>
110
               <OutsourcedOperation>
111
                    <IsOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

>{Boolean}</IsOutsourced>
112
               </OutsourcedOperation>
113
               <ProductStructure>
114
                    <ProductStructureId
ProductStructureId

Product structure identifier

>{Integer}</ProductStructureId>
115
                    <ProductStructureLink
ProductStructureLink

Product structure reference

>{String}</ProductStructureLink>
116
               </ProductStructure>
117
               <ProductStructureVersion>
118
                    <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

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

Product structure reference

>{String}</ProductStructureVersionLink>
120
               </ProductStructureVersion>
121
          </ProductStructureOperation>
122
          <LatestOperator>
123
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
127
          </LatestOperator>
128
          <OutsourcedOperationPurchaseOrderItem>
129
               <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

>{Integer}</PurchaseOrderItemId>
130
               <PurchaseOrder>
131
                    <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

>{Integer}</PurchaseOrderId>
132
                    <PurchaseOrderLink
PurchaseOrderLink

Purchase order reference

>{String}</PurchaseOrderLink>
133
               </PurchaseOrder>
134
               <PurchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>
135
          </OutsourcedOperationPurchaseOrderItem>
136
          <WorkOrderOperationLink
WorkOrderOperationLink

Work order operation reference

>{String}</WorkOrderOperationLink>
137
     </WorkOrderOperation>
138
     <Paging
Paging

Detailed paging information for this list.

>
139
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
142
          <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>
143
          <FirstPage
FirstPage

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

>{String}</FirstPage>
144
          <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>
145
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
146
          <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>
147
          <NextPage
NextPage

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

>{String}</NextPage>
148
          <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>
149
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
151
     </Paging>
152
</WorkOrderOperations>
1
{
2
     "workOrderOperations": [
3
          {
4
               "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

Production work order operation status

Possible domain values can be found here

": "{Integer}",
6
               "extendedStatus
ExtendedStatus

Extended Work Order Operation status information

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
8
               "updatedAt
UpdatedAt

Date and time of update

": "{Datetime}",
9
               "plannedStartAt
PlannedStartAt

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

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

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

": "{Datetime}",
11
               "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}",
12
               "startedAt
StartedAt

Date and time work order operation actually started

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

Date and time of completion

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

True if work order operation is paused

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

Flag which indicates if Work Order Operation has been prioritized

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

Date and time quetime is completed

": "{Datetime}",
17
               "quantity
Quantity

Quantity of the work order operation

": "{Decimal}",
18
               "productPlacement
ProductPlacement

The placement of the product after completed work order operation

": "{String}",
19
               "additionalManHours
AdditionalManHours

Additional labour hours or man hours in this work order operation.

": "{Decimal}",
20
               "processing": {
21
                    "isProcessingCompleted
IsProcessingCompleted

True if processing is completed

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

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

": "{Decimal}"
24
               },
25
               "changeover": {
26
                    "isSetupCompleted
IsSetupCompleted

True if setup changeover is completed

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

Time in hours used for setup changeover

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

True if cleanup changeover is completed

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

Time in hours used for cleanup changeover

": "{Decimal}"
30
               },
31
               "costOverrun
CostOverrun

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

": {
32
                    "hasCostOverrun
HasCostOverrun

Flag to indicate if product structure's operation has got cost deviation

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

": "{Boolean}",
33
                    "approvedAmount
ApprovedAmount

Cost overrun approved value

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

": "{Decimal}",
34
                    "amount
Amount

Value of product structure's operation cost deviation

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

": "{Decimal}"
35
               },
36
               "timeOverrun
TimeOverrun

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

": {
37
                    "hasTimeOverrun
HasTimeOverrun

Flag to indicate if product structure's operation has got worklog deviation

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

": "{Boolean}",
38
                    "percent
Percent

Percentage value of product structure's operation worklog deviation

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

": "{Decimal}"
39
               },
40
               "onHold": {
41
                    "isOnHold
IsOnHold

True if work order operation is on hold

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

Date and time work order operation was set on hold

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

Date and time work order operation should be on hold to

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

A category of work order operation on hold reason

Possible domain values can be found here

": "{Integer}",
45
                    "causedBy
CausedBy

A side responsible for causing work order operation on hold

Possible domain values can be found here

": "{String}",
46
                    "reason
Reason

Reason for setting work order operation on hold

": "{String}",
47
                    "onHoldBy
OnHoldBy

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

": {
48
                         "userId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

": "{String}",
51
                         "userLink
UserLink

User reference

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

": "{String}"
52
                    }
53
               },
54
               "productionWorkOrder": {
55
                    "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

": "{Integer}",
56
                    "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}",
57
                    "onHold": {
58
                         "isOnHold
IsOnHold

Flag to indicate if production work order is on hold

": "{Boolean}"
59
                    },
60
                    "productionFor": {
61
                         "database
Database

Database of the object

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

Item-number of the object

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

Type of item

": "{String}",
64
                         "object": {
65
                              "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
67
                              "customer": {
68
                                   "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

": "{String}"
71
                              },
72
                              "objectLink
ObjectLink

API reference to the object

": "{String}"
73
                         },
74
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}"
76
                    },
77
                    "product": {
78
                         "productId
ProductId

Product identifier

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

Name of the product

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

Product reference

": "{String}"
81
                    },
82
                    "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

": "{String}"
83
               },
84
               "productStructureOperation": {
85
                    "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

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

": "{Integer}",
87
                    "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}",
88
                    "processing": {
89
                         "runTime
RunTime

Runtime of the product structure operation. Changeover time is not included here.

": "{Decimal}"
90
                    },
91
                    "changeover": {
92
                         "setupTime
SetupTime

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

": "{Decimal}"
94
                    },
95
                    "productionOperation": {
96
                         "productionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

": "{String}"
99
                    },
100
                    "productionResource": {
101
                         "productionResourceId
ProductionResourceId

Production resource identifier

": "{Integer}",
102
                         "allowMultipleOperators
AllowMultipleOperators

True if multiple operators can work with one work order operation.

": "{Boolean}",
103
                         "name
Name

Name of production resource

": "{String}",
104
                         "productionResourceLink
ProductionResourceLink

Production resource reference

": "{String}"
105
                    },
106
                    "productionResourceGroup": {
107
                         "productionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

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

": "{String}",
109
                         "productionResourceGroupLink
ProductionResourceGroupLink

Production resource group reference

": "{String}"
110
                    },
111
                    "outsourcedOperation": {
112
                         "isOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

": "{Boolean}"
113
                    },
114
                    "productStructure": {
115
                         "productStructureId
ProductStructureId

Product structure identifier

": "{Integer}",
116
                         "productStructureLink
ProductStructureLink

Product structure reference

": "{String}"
117
                    },
118
                    "productStructureVersion": {
119
                         "productStructureVersionId
ProductStructureVersionId

Product structure identifier

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

Product structure reference

": "{String}"
121
                    }
122
               },
123
               "latestOperator": {
124
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
128
               },
129
               "outsourcedOperationPurchaseOrderItem": {
130
                    "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

": "{Integer}",
131
                    "purchaseOrder": {
132
                         "purchaseOrderId
PurchaseOrderId

Purchase order identifier

": "{Integer}",
133
                         "purchaseOrderLink
PurchaseOrderLink

Purchase order reference

": "{String}"
134
                    },
135
                    "purchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

": "{String}"
136
               },
137
               "workOrderOperationLink
WorkOrderOperationLink

Work order operation reference

": "{String}"
138
          }
139
     ],
140
     "paging
Paging

Detailed paging information for this list.

": {
141
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
144
          "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}",
145
          "firstPage
FirstPage

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

": "{String}",
146
          "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}",
147
          "previousPage
PreviousPage

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

": "{String}",
148
          "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}",
149
          "nextPage
NextPage

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

": "{String}",
150
          "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}",
151
          "lastPage
LastPage

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

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

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

": "{Integer}"
153
     }
154
}

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 100199 HTTP 404 Location is not found
Error 100055 HTTP 403 You have only admittance to your own objects