API

Production APIs

GET production/work-order-operations/{workOrderOperationId}

Work order operation details for provided identifier

HTTP method GET
URI https://api.rambase.net/production/work-order-operations/{workOrderOperationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {workOrderOperationId} Production work order operation identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2329, version 68

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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

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

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
<WorkOrderOperation>
2
     <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

Production work order operation status

Possible domain values can be found here

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

Extended Work Order Operation status information

Possible domain values can be found here

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

Date and time of creation

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

Date and time of update

>{Datetime}</UpdatedAt>
7
     <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>
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
     <StartedAt
StartedAt

Date and time work order operation actually started

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

Date and time of completion

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

True if work order operation is paused

>{Boolean}</IsPaused>
13
     <WaitTimeEndsAt
WaitTimeEndsAt

Date and time quetime is completed

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

Quantity of the work order operation

>{Decimal}</Quantity>
15
     <CompletedQuantity
CompletedQuantity

Quantity completed in this work order operation

>{Decimal}</CompletedQuantity>
16
     <ScrappedQuantity
ScrappedQuantity

Quantity of recyclable items left over from work order operation. Note that unlike waste, scrap has monetary value.

>{Decimal}</ScrappedQuantity>
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
     <HasPriority
HasPriority

Flag which indicates if Work Order Operation has been prioritized

>{Boolean}</HasPriority>
20
     <PlannedStartAtMargin
PlannedStartAtMargin

Critical days

>{Integer}</PlannedStartAtMargin>
21
     <CanBeGrouped
CanBeGrouped

A flag indicating if work order operation can be grouped

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

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

Picking status of work order operation

Possible domain values can be found here

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

>{Integer}</PickingStatus>
23
     <Note
Note

Text field used by operators to write information

>{String}</Note>
24
     <Processing>
25
          <IsProcessingCompleted
IsProcessingCompleted

True if processing is completed

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

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

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

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

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

True if setup changeover is completed

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

Time in hours used for setup changeover

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

True if cleanup changeover is completed

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

Time in hours used for cleanup changeover

>{Decimal}</CleanupTime>
34
     </Changeover>
35
     <CostOverrun
CostOverrun

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

>
36
          <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=CostOverrun in your request URI to get this field

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

Cost overrun approved value

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

>{Decimal}</ApprovedAmount>
38
          <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=CostOverrun in your request URI to get this field

>{Decimal}</Amount>
39
          <ApprovedBy
ApprovedBy

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

>
40
               <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
44
          </ApprovedBy>
45
     </CostOverrun>
46
     <TimeOverrun
TimeOverrun

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

>
47
          <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=TimeOverrun in your request URI to get this field

>{Boolean}</HasTimeOverrun>
48
          <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=TimeOverrun in your request URI to get this field

>{Decimal}</Percent>
49
          <ApprovedBy
ApprovedBy

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

>
50
               <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
54
          </ApprovedBy>
55
     </TimeOverrun>
56
     <Checkpoint>
57
          <Description
Description

The checkpoint text

>{String}</Description>
58
          <IsApproved
IsApproved

True if checkpoint is approved

>{Boolean}</IsApproved>
59
          <ApprovedAt
ApprovedAt

Date and time of checkpoint approval

>{Datetime}</ApprovedAt>
60
          <ApprovedBy>
61
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
65
          </ApprovedBy>
66
     </Checkpoint>
67
     <OnHold>
68
          <IsOnHold
IsOnHold

True if work order operation is on hold

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

Date and time work order operation was set on hold

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

Date and time work order operation should be on hold to

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

A category of work order operation on hold reason

Possible domain values can be found here

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

A side responsible for causing work order operation on hold

Possible domain values can be found here

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

Reason for setting work order operation on hold

>{String}</Reason>
74
          <OnHoldBy>
75
               <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
79
          </OnHoldBy>
80
     </OnHold>
81
     <ProductionWorkOrder>
82
          <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
83
          <Status
Status

Status of production work order

Possible domain values can be found here

>{Integer}</Status>
84
          <Type
Type

Type of production work order

Possible domain values can be found here

>{String}</Type>
85
          <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>
86
          <ProductRevision
ProductRevision

Product revision used for this production work order

>{String}</ProductRevision>
87
          <IsManufacturedInBatches
IsManufacturedInBatches

Is Production Work Order is batch type production

>{Boolean}</IsManufacturedInBatches>
88
          <OnHold>
89
               <IsOnHold
IsOnHold

Flag to indicate if production work order is on hold

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

Date of putting production work order on hold

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

Date and time production work order should be on hold to

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

A category of production work order on hold reason

Possible domain values can be found here

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

A side responsible for causing production work order on hold

Possible domain values can be found here

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

Reason of putting production work order on hold

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

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

>
96
                    <UserId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

>{String}</UserLink>
100
               </OnHoldBy>
101
          </OnHold>
102
          <ProductionFor>
103
               <Database
Database

Database of the object

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

Item-number of the object

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

Type of item

>{String}</ItemType>
106
               <Object>
107
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
109
                    <Customer>
110
                         <CustomerId
CustomerId

Customer identifier

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

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

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

Customer reference

>{String}</CustomerLink>
113
                    </Customer>
114
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
115
               </Object>
116
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
118
          </ProductionFor>
119
          <Product>
120
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

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

Product reference

>{String}</ProductLink>
124
          </Product>
125
          <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

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

Product structure operation identifier

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

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

>{Integer}</SequenceNumber>
130
          <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>
131
          <Processing>
132
               <RunTime
RunTime

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

>{Decimal}</RunTime>
133
          </Processing>
134
          <Changeover>
135
               <SetupTime
SetupTime

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

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

Production operation identifier

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

Name of production operation

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

Type of operation

Possible domain values can be found here

>{String}</Type>
142
               <ProductionOperationLink
ProductionOperationLink

Production operation reference

>{String}</ProductionOperationLink>
143
          </ProductionOperation>
144
          <ProductionResourceGroup>
145
               <ProductionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

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

Production resource group reference

>{String}</ProductionResourceGroupLink>
148
          </ProductionResourceGroup>
149
          <ProductionResource>
150
               <ProductionResourceId
ProductionResourceId

Production resource identifier

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

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

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

Name of production resource

>{String}</Name>
153
               <AllowManHours
AllowManHours

True if man hours can be added to the work log of work order operations

>{Boolean}</AllowManHours>
154
               <Condition>
155
                    <Code
Code

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

Possible domain values can be found here

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

A description which explains a reason for setting production resource state

>{String}</Note>
157
               </Condition>
158
               <ProductionResourceLink
ProductionResourceLink

Production resource reference

>{String}</ProductionResourceLink>
159
          </ProductionResource>
160
          <OutsourcedOperation>
161
               <IsOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

>{Boolean}</IsOutsourced>
162
               <LeadTime
LeadTime

Material lead time in days for external operations

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

>{Integer}</LeadTime>
163
          </OutsourcedOperation>
164
          <ProductStructure>
165
               <ProductStructureId
ProductStructureId

Product structure identifier

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

Product structure reference

>{String}</ProductStructureLink>
167
          </ProductStructure>
168
          <ProductStructureVersion>
169
               <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

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

Product structure reference

>{String}</ProductStructureVersionLink>
171
          </ProductStructureVersion>
172
     </ProductStructureOperation>
173
     <LatestOperator>
174
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
178
     </LatestOperator>
179
     <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=NumberOfScheduledTaskProcesses in your request URI to get this field

>{Integer}</NumberOfScheduledTaskProcesses>
180
     <OutsourcedOperationPurchaseOrderItem>
181
          <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

>{Integer}</PurchaseOrderItemId>
182
          <PurchaseOrder>
183
               <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

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

Purchase order reference

>{String}</PurchaseOrderLink>
185
          </PurchaseOrder>
186
          <PurchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>
187
     </OutsourcedOperationPurchaseOrderItem>
188
     <WorkOrderOperationGroup>
189
          <WorkOrderOperationGroupId
WorkOrderOperationGroupId

Work order operation group identifier

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

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

Name of Work Order Operation Group

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

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

Creation date for Group Work Order Operation

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

>{Date}</CreatedAt>
192
          <Type
Type

Type of work order operation group

Possible domain values can be found here

>{String}</Type>
193
          <WorkOrderOperationGroupLink
WorkOrderOperationGroupLink

Work order operation group's reference

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

>{String}</WorkOrderOperationGroupLink>
194
     </WorkOrderOperationGroup>
195
</WorkOrderOperation>
1
{
2
     "workOrderOperation": {
3
          "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

Production work order operation status

Possible domain values can be found here

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

Extended Work Order Operation status information

Possible domain values can be found here

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

Date and time of creation

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

Date and time of update

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

Date and time work order operation actually started

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

Date and time of completion

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

True if work order operation is paused

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

Date and time quetime is completed

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

Quantity of the work order operation

": "{Decimal}",
16
          "completedQuantity
CompletedQuantity

Quantity completed in this work order operation

": "{Decimal}",
17
          "scrappedQuantity
ScrappedQuantity

Quantity of recyclable items left over from work order operation. Note that unlike waste, scrap has monetary value.

": "{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
          "hasPriority
HasPriority

Flag which indicates if Work Order Operation has been prioritized

": "{Boolean}",
21
          "plannedStartAtMargin
PlannedStartAtMargin

Critical days

": "{Integer}",
22
          "canBeGrouped
CanBeGrouped

A flag indicating if work order operation can be grouped

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

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

Picking status of work order operation

Possible domain values can be found here

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

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

Text field used by operators to write information

": "{String}",
25
          "processing": {
26
               "isProcessingCompleted
IsProcessingCompleted

True if processing is completed

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

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

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

True if setup changeover is completed

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

Time in hours used for setup changeover

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

True if cleanup changeover is completed

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

Time in hours used for cleanup changeover

": "{Decimal}"
35
          },
36
          "costOverrun
CostOverrun

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

": {
37
               "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=CostOverrun in your request URI to get this field

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

Cost overrun approved value

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

": "{Decimal}",
39
               "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=CostOverrun in your request URI to get this field

": "{Decimal}",
40
               "approvedBy
ApprovedBy

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

": {
41
                    "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
45
               }
46
          },
47
          "timeOverrun
TimeOverrun

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

": {
48
               "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=TimeOverrun in your request URI to get this field

": "{Boolean}",
49
               "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=TimeOverrun in your request URI to get this field

": "{Decimal}",
50
               "approvedBy
ApprovedBy

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

": {
51
                    "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
55
               }
56
          },
57
          "checkpoint": {
58
               "description
Description

The checkpoint text

": "{String}",
59
               "isApproved
IsApproved

True if checkpoint is approved

": "{Boolean}",
60
               "approvedAt
ApprovedAt

Date and time of checkpoint approval

": "{Datetime}",
61
               "approvedBy": {
62
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
66
               }
67
          },
68
          "onHold": {
69
               "isOnHold
IsOnHold

True if work order operation is on hold

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

Date and time work order operation was set on hold

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

Date and time work order operation should be on hold to

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

A category of work order operation on hold reason

Possible domain values can be found here

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

A side responsible for causing work order operation on hold

Possible domain values can be found here

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

Reason for setting work order operation on hold

": "{String}",
75
               "onHoldBy": {
76
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
80
               }
81
          },
82
          "productionWorkOrder": {
83
               "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

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

Status of production work order

Possible domain values can be found here

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

Type of production work order

Possible domain values can be found here

": "{String}",
86
               "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}",
87
               "productRevision
ProductRevision

Product revision used for this production work order

": "{String}",
88
               "isManufacturedInBatches
IsManufacturedInBatches

Is Production Work Order is batch type production

": "{Boolean}",
89
               "onHold": {
90
                    "isOnHold
IsOnHold

Flag to indicate if production work order is on hold

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

Date of putting production work order on hold

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

Date and time production work order should be on hold to

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

A category of production work order on hold reason

Possible domain values can be found here

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

A side responsible for causing production work order on hold

Possible domain values can be found here

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

Reason of putting production work order on hold

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

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

": {
97
                         "userId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

": "{String}"
101
                    }
102
               },
103
               "productionFor": {
104
                    "database
Database

Database of the object

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

Item-number of the object

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

Type of item

": "{String}",
107
                    "object": {
108
                         "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
110
                         "customer": {
111
                              "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

": "{String}"
114
                         },
115
                         "objectLink
ObjectLink

API reference to the object

": "{String}"
116
                    },
117
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}"
119
               },
120
               "product": {
121
                    "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

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

Product reference

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

Production work order reference

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

Product structure operation identifier

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

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

": "{Integer}",
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}",
132
               "processing": {
133
                    "runTime
RunTime

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

": "{Decimal}"
134
               },
135
               "changeover": {
136
                    "setupTime
SetupTime

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

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

Production operation identifier

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

Name of production operation

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

Type of operation

Possible domain values can be found here

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

Production operation reference

": "{String}"
144
               },
145
               "productionResourceGroup": {
146
                    "productionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

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

Production resource group reference

": "{String}"
149
               },
150
               "productionResource": {
151
                    "productionResourceId
ProductionResourceId

Production resource identifier

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

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

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

Name of production resource

": "{String}",
154
                    "allowManHours
AllowManHours

True if man hours can be added to the work log of work order operations

": "{Boolean}",
155
                    "condition": {
156
                         "code
Code

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

Possible domain values can be found here

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

A description which explains a reason for setting production resource state

": "{String}"
158
                    },
159
                    "productionResourceLink
ProductionResourceLink

Production resource reference

": "{String}"
160
               },
161
               "outsourcedOperation": {
162
                    "isOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

": "{Boolean}",
163
                    "leadTime
LeadTime

Material lead time in days for external operations

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

": "{Integer}"
164
               },
165
               "productStructure": {
166
                    "productStructureId
ProductStructureId

Product structure identifier

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

Product structure reference

": "{String}"
168
               },
169
               "productStructureVersion": {
170
                    "productStructureVersionId
ProductStructureVersionId

Product structure identifier

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

Product structure reference

": "{String}"
172
               }
173
          },
174
          "latestOperator": {
175
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
179
          },
180
          "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=NumberOfScheduledTaskProcesses in your request URI to get this field

": "{Integer}",
181
          "outsourcedOperationPurchaseOrderItem": {
182
               "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

": "{Integer}",
183
               "purchaseOrder": {
184
                    "purchaseOrderId
PurchaseOrderId

Purchase order identifier

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

Purchase order reference

": "{String}"
186
               },
187
               "purchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

": "{String}"
188
          },
189
          "workOrderOperationGroup": {
190
               "workOrderOperationGroupId
WorkOrderOperationGroupId

Work order operation group identifier

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

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

Name of Work Order Operation Group

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

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

Creation date for Group Work Order Operation

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

": "{Date}",
193
               "type
Type

Type of work order operation group

Possible domain values can be found here

": "{String}",
194
               "workOrderOperationGroupLink
WorkOrderOperationGroupLink

Work order operation group's reference

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

": "{String}"
195
          }
196
     }
197
}

Possible error codes the response might return:

Error 99946 HTTP 400 {0}: Missing mandatory arguments {1}
Error 101231 HTTP 404 Production work order item {0}-{1} not found