API

Production APIs

GET production/work-orders

List of production work orders

HTTP method GET
URI https://api.rambase.net/production/work-orders
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 622, version 70

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.

Active() Named filter Registered- and not processed production work orders (status not 1 and not 9)
InProduction() Named filter Production work orders which are in production
InScrappingProcess() Named filter Production work orders which are in scrapping process
Processed() Named filter Production work orders which are processed
ProductionCompleted() Named filter Production work orders which are completed
WaitGoodsReception() Named filter Production work orders which are pending goods reception
WaitProductionStart() Named filter Production work orders which are pending scheduled production start
WaitPurchaseOrProd() Named filter Production work orders which are pending purchase or production
WaitRegistration() Named filter Production work orders which are pending registrationn
ConfirmedCompletionDate Date The confirmed date of completion for the production work order. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerId Integer Customer identifier.
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.
CustomField1 String Custom field for grouping, sorting, categorizing and other purposes.
CustomField2 String Custom field for grouping, sorting, categorizing and other purposes.
FinanceProjectId Integer Finance project identifier.
ForwardedFromObjectId Docref-noitm Identifier of the object.
ForwardedFromObjectType String Type of object.
HasPriority Boolean Production Work Order priority.
InitialWorkOrderId Docref-noitm Production work order identifier.
IsOnHold Boolean Flag to indicate if production work order is on hold.
LocationShortName String Unique abbreviation/short name of the location.
ManufacturingAreaId Integer Manufacturing area identifier.
ManufacturingAreaName String Name of manufacturing area.
PlannerId Integer Employee identifier. Available macros: currentUser()
PlanningCategory String Planning category.
ProductClassificationId String Product classification identifier.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier.
ProductionForObjectId Integer Identifier of the order document.
ProductionForObjectType Docref-dbarch Identifier of the order document.
ProductionWorkOrderId Integer Production work order identifier.
ProductName String Name of the product.
Quantity Decimal The quantity that will be (or has been) produced.
RemainingQuantity Decimal Remaining number of units to produce.
RequestedCompletionDate Date The requested date of completion for the production work order. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ScheduledCompletionDate Date Scheduled/planned date of production completion. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ScheduledStartDate Date Scheduled/planned date of production start. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ScrapReason Integer Reason for scrapping.
Status Integer Status of production work order.
Type String Type of production work order.
UpdatedAt Datetime Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

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

ConfirmedCompletionDate Date The confirmed date of completion for the production work order
CreatedAt Datetime Date and time of creation
CustomerId Integer Customer identifier
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.
CustomField1 String Custom field for grouping, sorting, categorizing and other purposes.
CustomField2 String Custom field for grouping, sorting, categorizing and other purposes.
FinanceProjectId Integer Finance project identifier
ForwardedFromObjectId Docref-noitm Identifier of the object
ForwardedFromObjectType String Type of object
HasPriority Boolean Production Work Order priority
InitialWorkOrderId Docref-noitm Production work order identifier
IsOnHold Boolean Flag to indicate if production work order is on hold
LocationShortName String Unique abbreviation/short name of the location
ManufacturingAreaId Integer Manufacturing area identifier
ManufacturingAreaName String Name of manufacturing area
PlannerId Integer Employee identifier
PlanningCategory String Planning category
ProductClassificationId String Product classification identifier
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier
ProductionForObjectId Integer Identifier of the order document
ProductionForObjectType Docref-dbarch Identifier of the order document
ProductionWorkOrderId Integer Production work order identifier
ProductName String Name of the product
Quantity Decimal The quantity that will be (or has been) produced
RemainingQuantity Decimal Remaining number of units to produce
RequestedCompletionDate Date The requested date of completion for the production work order.
ScheduledCompletionDate Date Scheduled/planned date of production completion
ScheduledStartDate Date Scheduled/planned date of production start
ScrapReason Integer Reason for scrapping
Status Integer Status of production work order
Type String Type of production work order
UpdatedAt Datetime Date and time of update

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
<ProductionWorkOrders>
2
     <ProductionWorkOrder>
3
          <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

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

Status of production work order

Possible domain values can be found here

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

Type of production work order

Possible domain values can be found here

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

Date and time of creation

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

Date and time of update

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

The requested date of completion for the production work order.

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

The confirmed date of completion for the production work order

>{Date}</ConfirmedCompletionDate>
10
          <IsConfirmedCompletionDateLocked
IsConfirmedCompletionDateLocked

If true, confirmed delivery date is locked.

>{Boolean}</IsConfirmedCompletionDateLocked>
11
          <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>
12
          <IsBlockedForProduction
IsBlockedForProduction

Is Production Work Order blocked for production

>{Boolean}</IsBlockedForProduction>
13
          <IsManufacturedInBatches
IsManufacturedInBatches

Is Production Work Order is batch type production

>{Boolean}</IsManufacturedInBatches>
14
          <AvailableQuantityInPercent
AvailableQuantityInPercent

Remaining production available percent

>{Decimal}</AvailableQuantityInPercent>
15
          <MaterialDelayedDays
MaterialDelayedDays

Number of days that material for the PWO is delayed.

>{Integer}</MaterialDelayedDays>
16
          <ProductRevision
ProductRevision

Product revision used for this production work order

>{String}</ProductRevision>
17
          <Quantity
Quantity

The quantity that will be (or has been) produced

>{Decimal}</Quantity>
18
          <ScheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

>{Date}</ScheduledStartDate>
19
          <ScheduledCompletionDate
ScheduledCompletionDate

Scheduled/planned date of production completion

>{Date}</ScheduledCompletionDate>
20
          <RemainingQuantity
RemainingQuantity

Remaining number of units to produce

>{Decimal}</RemainingQuantity>
21
          <HasMaterialShortage
HasMaterialShortage

True if production has supply shortage (negative metarial trend)

>{Boolean}</HasMaterialShortage>
22
          <IsBlockedForPurchase
IsBlockedForPurchase

True if materials in this production work order should not be purchased

>{Boolean}</IsBlockedForPurchase>
23
          <HasPriority
HasPriority

Production Work Order priority

>{Boolean}</HasPriority>
24
          <LatestStartAt
LatestStartAt

Latest possibile date of starting production

>{Datetime}</LatestStartAt>
25
          <HasProcessRunning
HasProcessRunning

Is Production Work Order is beeing currenlty processed by internal process

>{Boolean}</HasProcessRunning>
26
          <NeedsMaterialReplacementToRelease
NeedsMaterialReplacementToRelease

Has replace before production material

>{Boolean}</NeedsMaterialReplacementToRelease>
27
          <HasStandardStructure
HasStandardStructure

Production Work Order has customers structure

>{Boolean}</HasStandardStructure>
28
          <ManufacturedProductName
ManufacturedProductName

Name of production work order item

>{String}</ManufacturedProductName>
29
          <PlanningCategory
PlanningCategory

Planning category

Possible domain values can be found here

>{String}</PlanningCategory>
30
          <OnHold>
31
               <IsOnHold
IsOnHold

Flag to indicate if production work order is on hold

>{Boolean}</IsOnHold>
32
               <Reason
Reason

Reason of putting production work order on hold

>{String}</Reason>
33
               <OnHoldAt
OnHoldAt

Date of putting production work order on hold

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

Date and time production work order should be on hold to

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

A category of production work order on hold reason

Possible domain values can be found here

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

A side responsible for causing production work order on hold

Possible domain values can be found here

>{String}</CausedBy>
37
               <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

>
38
                    <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>
39
                    <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>
40
               </OnHoldBy>
41
          </OnHold>
42
          <ProductionFor>
43
               <Database
Database

Database of the object

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

Item-number of the object

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

Type of item

>{String}</ItemType>
46
               <Object>
47
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
49
                    <Customer>
50
                         <CustomerId
CustomerId

Customer identifier

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

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

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

Customer reference

>{String}</CustomerLink>
53
                    </Customer>
54
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
55
               </Object>
56
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
58
          </ProductionFor>
59
          <Location
Location

The location of the production.

>
60
               <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
61
          </Location>
62
          <Product>
63
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the item. If not specified, the description is by default copied from the product.

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

Type of product

Possible domain values can be found here

>{String}</Type>
67
               <CustomField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField1>
68
               <CustomField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField2>
69
               <ProductClassification>
70
                    <ProductClassificationId
ProductClassificationId

Product classification identifier

>{String}</ProductClassificationId>
71
                    <ProductClassificationLink
ProductClassificationLink

Product classification reference

>{String}</ProductClassificationLink>
72
               </ProductClassification>
73
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
74
          </Product>
75
          <ProductStructure>
76
               <ProductStructureId
ProductStructureId

Product structure reference

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

Product structure reference

>{String}</ProductStructureLink>
78
          </ProductStructure>
79
          <FinanceProject>
80
               <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
81
               <Name
Name

Name of finance project

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

>{String}</Name>
82
               <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
83
          </FinanceProject>
84
          <SalesDeliveryProject
SalesDeliveryProject

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

>
85
               <SalesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

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

Name of sales delivery

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

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

Sales delivery project reference

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

>{String}</SalesDeliveryProjectLink>
88
          </SalesDeliveryProject>
89
          <ProductionPlanner>
90
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
94
          </ProductionPlanner>
95
          <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
96
               <ForwardedFromItem>
97
                    <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
98
                    <Object>
99
                         <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
101
                         <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
102
                    </Object>
103
                    <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
104
               </ForwardedFromItem>
105
          </ForwardedFrom>
106
          <Scrap>
107
               <IsScrapped
IsScrapped

True, if element is being scrapped.

>{Boolean}</IsScrapped>
108
               <Reason
Reason

Reason for scrapping

Possible domain values can be found here

>{Integer}</Reason>
109
          </Scrap>
110
          <ForwardedTo
ForwardedTo

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

>
111
               <OpenForwardedQuantity
OpenForwardedQuantity

When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.

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

>{Decimal}</OpenForwardedQuantity>
112
               <ForwardedToItems
ForwardedToItems

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

>
113
                    <Item
Item

Item this item was forwarded to.

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

>
114
                         <ItemId
ItemId

Identifier of the object

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

>{Integer}</ItemId>
115
                         <Object
Object

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

>
116
                              <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

>{String}</ObjectType>
118
                              <ObjectLink
ObjectLink

API reference to the object

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

>{String}</ObjectLink>
119
                         </Object>
120
                         <ItemLink
ItemLink

API reference to the item

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

>{String}</ItemLink>
121
                    </Item>
122
               </ForwardedToItems>
123
          </ForwardedTo>
124
          <ManufacturingArea>
125
               <ManufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

>{Integer}</ManufacturingAreaId>
126
               <Name
Name

Name of manufacturing area

>{String}</Name>
127
               <ManufacturingAreaLink
ManufacturingAreaLink

Manufacturing area reference

>{String}</ManufacturingAreaLink>
128
          </ManufacturingArea>
129
          <CostOverrun
CostOverrun

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

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

>{Boolean}</HasCostOverrun>
131
          </CostOverrun>
132
          <TimeOverrun
TimeOverrun

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

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

>{Boolean}</HasTimeOverrun>
134
          </TimeOverrun>
135
          <Management>
136
               <ProjectLeader
ProjectLeader

Reference to the employee who is a production management project leader.

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

>
137
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
141
               </ProjectLeader>
142
               <DocumentController
DocumentController

Reference to the employee who is a production management document controller.

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

>
143
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
147
               </DocumentController>
148
          </Management>
149
     </ProductionWorkOrder>
150
     <Paging
Paging

Detailed paging information for this list.

>
151
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
154
          <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>
155
          <FirstPage
FirstPage

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

>{String}</FirstPage>
156
          <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>
157
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
158
          <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>
159
          <NextPage
NextPage

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

>{String}</NextPage>
160
          <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>
161
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
163
     </Paging>
164
</ProductionWorkOrders>
1
{
2
     "productionWorkOrders": [
3
          {
4
               "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

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

Status of production work order

Possible domain values can be found here

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

Type of production work order

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
               "requestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

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

The confirmed date of completion for the production work order

": "{Date}",
11
               "isConfirmedCompletionDateLocked
IsConfirmedCompletionDateLocked

If true, confirmed delivery date is locked.

": "{Boolean}",
12
               "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}",
13
               "isBlockedForProduction
IsBlockedForProduction

Is Production Work Order blocked for production

": "{Boolean}",
14
               "isManufacturedInBatches
IsManufacturedInBatches

Is Production Work Order is batch type production

": "{Boolean}",
15
               "availableQuantityInPercent
AvailableQuantityInPercent

Remaining production available percent

": "{Decimal}",
16
               "materialDelayedDays
MaterialDelayedDays

Number of days that material for the PWO is delayed.

": "{Integer}",
17
               "productRevision
ProductRevision

Product revision used for this production work order

": "{String}",
18
               "quantity
Quantity

The quantity that will be (or has been) produced

": "{Decimal}",
19
               "scheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

": "{Date}",
20
               "scheduledCompletionDate
ScheduledCompletionDate

Scheduled/planned date of production completion

": "{Date}",
21
               "remainingQuantity
RemainingQuantity

Remaining number of units to produce

": "{Decimal}",
22
               "hasMaterialShortage
HasMaterialShortage

True if production has supply shortage (negative metarial trend)

": "{Boolean}",
23
               "isBlockedForPurchase
IsBlockedForPurchase

True if materials in this production work order should not be purchased

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

Production Work Order priority

": "{Boolean}",
25
               "latestStartAt
LatestStartAt

Latest possibile date of starting production

": "{Datetime}",
26
               "hasProcessRunning
HasProcessRunning

Is Production Work Order is beeing currenlty processed by internal process

": "{Boolean}",
27
               "needsMaterialReplacementToRelease
NeedsMaterialReplacementToRelease

Has replace before production material

": "{Boolean}",
28
               "hasStandardStructure
HasStandardStructure

Production Work Order has customers structure

": "{Boolean}",
29
               "manufacturedProductName
ManufacturedProductName

Name of production work order item

": "{String}",
30
               "planningCategory
PlanningCategory

Planning category

Possible domain values can be found here

": "{String}",
31
               "onHold": {
32
                    "isOnHold
IsOnHold

Flag to indicate if production work order is on hold

": "{Boolean}",
33
                    "reason
Reason

Reason of putting production work order on hold

": "{String}",
34
                    "onHoldAt
OnHoldAt

Date of putting production work order on hold

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

Date and time production work order should be on hold to

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

A category of production work order on hold reason

Possible domain values can be found here

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

A side responsible for causing production work order on hold

Possible domain values can be found here

": "{String}",
38
                    "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

": {
39
                         "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}",
40
                         "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}"
41
                    }
42
               },
43
               "productionFor": {
44
                    "database
Database

Database of the object

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

Item-number of the object

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

Type of item

": "{String}",
47
                    "object": {
48
                         "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
50
                         "customer": {
51
                              "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

": "{String}"
54
                         },
55
                         "objectLink
ObjectLink

API reference to the object

": "{String}"
56
                    },
57
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}"
59
               },
60
               "location
Location

The location of the production.

": {
61
                    "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}"
62
               },
63
               "product": {
64
                    "productId
ProductId

Product identifier

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

Name of the product

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

Description of the item. If not specified, the description is by default copied from the product.

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

Type of product

Possible domain values can be found here

": "{String}",
68
                    "customField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",
69
                    "customField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",
70
                    "productClassification": {
71
                         "productClassificationId
ProductClassificationId

Product classification identifier

": "{String}",
72
                         "productClassificationLink
ProductClassificationLink

Product classification reference

": "{String}"
73
                    },
74
                    "productLink
ProductLink

Product reference

": "{String}"
75
               },
76
               "productStructure": {
77
                    "productStructureId
ProductStructureId

Product structure reference

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

Product structure reference

": "{String}"
79
               },
80
               "financeProject": {
81
                    "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

": "{String}",
83
                    "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
84
               },
85
               "salesDeliveryProject
SalesDeliveryProject

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

": {
86
                    "salesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

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

Name of sales delivery

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

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

Sales delivery project reference

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

": "{String}"
89
               },
90
               "productionPlanner": {
91
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
95
               },
96
               "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

": {
97
                    "forwardedFromItem": {
98
                         "itemId
ItemId

Identifier of the object

": "{Integer}",
99
                         "object": {
100
                              "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
102
                              "objectLink
ObjectLink

API reference to the object

": "{String}"
103
                         },
104
                         "itemLink
ItemLink

API reference to the item

": "{String}"
105
                    }
106
               },
107
               "scrap": {
108
                    "isScrapped
IsScrapped

True, if element is being scrapped.

": "{Boolean}",
109
                    "reason
Reason

Reason for scrapping

Possible domain values can be found here

": "{Integer}"
110
               },
111
               "forwardedTo
ForwardedTo

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

": {
112
                    "openForwardedQuantity
OpenForwardedQuantity

When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.

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

": "{Decimal}",
113
                    "forwardedToItems
ForwardedToItems

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

": {
114
                         "item
Item

Item this item was forwarded to.

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

": {
115
                              "itemId
ItemId

Identifier of the object

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

": "{Integer}",
116
                              "object
Object

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

": {
117
                                   "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

": "{String}",
119
                                   "objectLink
ObjectLink

API reference to the object

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

": "{String}"
120
                              },
121
                              "itemLink
ItemLink

API reference to the item

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

": "{String}"
122
                         }
123
                    }
124
               },
125
               "manufacturingArea": {
126
                    "manufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

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

Name of manufacturing area

": "{String}",
128
                    "manufacturingAreaLink
ManufacturingAreaLink

Manufacturing area reference

": "{String}"
129
               },
130
               "costOverrun
CostOverrun

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

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

": "{Boolean}"
132
               },
133
               "timeOverrun
TimeOverrun

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

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

": "{Boolean}"
135
               },
136
               "management": {
137
                    "projectLeader
ProjectLeader

Reference to the employee who is a production management project leader.

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

": {
138
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
142
                    },
143
                    "documentController
DocumentController

Reference to the employee who is a production management document controller.

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

": {
144
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
148
                    }
149
               }
150
          }
151
     ],
152
     "paging
Paging

Detailed paging information for this list.

": {
153
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
165
     }
166
}

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 101746 HTTP 404 Product structure not found. Id: {0}
Error 100055 HTTP 403 You have only admittance to your own objects