API

Production APIs

GET production/work-orders/{productionWorkOrderId}

Production work order details for provided identifier

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

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

Production work order identifier

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

Status of production work order

Possible domain values can be found here

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

Type of production work order

Possible domain values can be found here

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

Date and time of creation

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

Date and time of update

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

Date of registration

>{Date}</RegistrationDate>
8
     <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>
9
     <NetWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

>{Decimal}</NetWeight>
10
     <RequestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

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

The confirmed date of completion for the production work order

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

If true, confirmed delivery date is locked.

>{Boolean}</IsConfirmedCompletionDateLocked>
13
     <ProductRevision
ProductRevision

Product revision used for this production work order

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

The quantity that will be (or has been) produced

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

Scheduled/planned date of production start

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

Scheduled/planned date of production completion

>{Date}</ScheduledCompletionDate>
17
     <EstimatedStartDate
EstimatedStartDate

Production work order estimated start date

>{Date}</EstimatedStartDate>
18
     <RemainingQuantity
RemainingQuantity

Remaining number of units to produce

>{Decimal}</RemainingQuantity>
19
     <PotentialProductionQuantity
PotentialProductionQuantity

Number of products possible to produce with the current stock.

>{Decimal}</PotentialProductionQuantity>
20
     <HasMaterialShortage
HasMaterialShortage

True if production has supply shortage (negative metarial trend)

>{Boolean}</HasMaterialShortage>
21
     <MaterialDelayedDays
MaterialDelayedDays

Number of days that material for the PWO is delayed.

>{Integer}</MaterialDelayedDays>
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
     <IsRework
IsRework

Is Pwroduction Work Order a rework production

>{Boolean}</IsRework>
25
     <CustomersReference
CustomersReference

Customer reference

>{String}</CustomersReference>
26
     <LatestStartAt
LatestStartAt

Latest possibile date of starting production

>{Datetime}</LatestStartAt>
27
     <AvailableQuantity
AvailableQuantity

The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned.

>{Decimal}</AvailableQuantity>
28
     <AvailableQuantityInPercent
AvailableQuantityInPercent

Remaining production available percent

>{Decimal}</AvailableQuantityInPercent>
29
     <HasProcessRunning
HasProcessRunning

Is Production Work Order is beeing currenlty processed by internal process

>{Boolean}</HasProcessRunning>
30
     <IsInFaultyState
IsInFaultyState

A flag to indicate if production work order is in faulty state (the work on the document should not be continueed until production work order got corrected)

>{Boolean}</IsInFaultyState>
31
     <NeedsMaterialReplacementToRelease
NeedsMaterialReplacementToRelease

Has replace before production material

>{Boolean}</NeedsMaterialReplacementToRelease>
32
     <IsManufacturedInBatches
IsManufacturedInBatches

Is Production Work Order is batch type production

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

Is Production Work Order blocked for production

>{Boolean}</IsBlockedForProduction>
34
     <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</Note>
35
     <HasStandardStructure
HasStandardStructure

Production Work Order has customers structure

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

Name of production work order item

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

Planning category

Possible domain values can be found here

>{String}</PlanningCategory>
38
     <ProductUnitMarkingSpecification
ProductUnitMarkingSpecification

Describes how to mark the product unit

>{String}</ProductUnitMarkingSpecification>
39
     <OnHold>
40
          <IsOnHold
IsOnHold

Flag to indicate if production work order is on hold

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

Date of putting production work order on hold

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

Date and time production work order should be on hold to

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

A category of production work order on hold reason

Possible domain values can be found here

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

A side responsible for causing production work order on hold

Possible domain values can be found here

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

Reason of putting production work order on hold

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

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

>
47
               <UserId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

>{String}</UserLink>
51
          </OnHoldBy>
52
     </OnHold>
53
     <ProductionFor>
54
          <Database
Database

Database of the object

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

Item-number of the object

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

Type of item

>{String}</ItemType>
57
          <Object>
58
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
60
               <Customer>
61
                    <CustomerId
CustomerId

Customer identifier

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

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

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

Customer reference

>{String}</CustomerLink>
64
               </Customer>
65
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
66
          </Object>
67
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
69
          <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmation date from linked order

>{Date}</ConfirmedDeliveryDate>
70
     </ProductionFor>
71
     <Location
Location

The location of the production.

>
72
          <LocationId
LocationId

Location identifier

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

>{Integer}</LocationId>
73
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
74
          <LocationLink
LocationLink

Location reference

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

>{String}</LocationLink>
75
     </Location>
76
     <MeasurementUnit>
77
          <MeasurementUnitId
MeasurementUnitId

Material unit reference

>{Integer}</MeasurementUnitId>
78
          <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>
79
          <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
80
     </MeasurementUnit>
81
     <Product>
82
          <ProductId
ProductId

Product identifier

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

Name of the product

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

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

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

Type of product

Possible domain values can be found here

>{String}</Type>
86
          <CountryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

>{String}</CountryOfOriginCode>
87
          <CustomField1
CustomField1

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

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

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

>{String}</CustomField2>
89
          <Dimensions>
90
               <Weight
Weight

The weight of the product in kilograms.

>{Decimal}</Weight>
91
          </Dimensions>
92
          <Manufacturer>
93
               <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
94
               <ShortName
ShortName

Shortname/code of the manufacturer

>{String}</ShortName>
95
               <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
96
          </Manufacturer>
97
          <ProductClassification>
98
               <ProductClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

>{String}</ProductClassificationLink>
100
          </ProductClassification>
101
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
102
     </Product>
103
     <Price>
104
          <GrossPrice
GrossPrice

Production Work Order article price

>{Decimal}</GrossPrice>
105
          <Currency
Currency

Production Work Order article prices currency

>{String}</Currency>
106
     </Price>
107
     <ProductStructure>
108
          <ProductStructureId
ProductStructureId

Product structure reference

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

Product structure reference

>{String}</ProductStructureLink>
110
     </ProductStructure>
111
     <FinanceProject>
112
          <FinanceProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

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

Finance project reference

>{String}</FinanceProjectLink>
115
     </FinanceProject>
116
     <SalesDeliveryProject
SalesDeliveryProject

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

>
117
          <SalesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

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

Name of sales delivery

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

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

Sales delivery project reference

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

>{String}</SalesDeliveryProjectLink>
120
     </SalesDeliveryProject>
121
     <Department>
122
          <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
123
          <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
124
     </Department>
125
     <ProductionPlanner>
126
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
130
     </ProductionPlanner>
131
     <InitialWorkOrder
InitialWorkOrder

Initial Production Work Order that current work order originated from

>
132
          <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
133
          <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>
134
     </InitialWorkOrder>
135
     <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
136
          <ForwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

>{Decimal}</ForwardedQuantity>
137
          <ForwardedFromItem>
138
               <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
139
               <Object>
140
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>{String}</ObjectLink>
143
               </Object>
144
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
145
          </ForwardedFromItem>
146
     </ForwardedFrom>
147
     <Scrap>
148
          <IsScrapped
IsScrapped

True, if element is being scrapped.

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

Reason for scrapping

Possible domain values can be found here

>{Integer}</Reason>
150
     </Scrap>
151
     <ForwardedTo
ForwardedTo

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

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

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

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

>
154
               <Item
Item

Item this item was forwarded to.

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

>
155
                    <ItemId
ItemId

Identifier of the object

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

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

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

>
157
                         <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

>{String}</ObjectLink>
160
                    </Object>
161
                    <ItemLink
ItemLink

API reference to the item

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

>{String}</ItemLink>
162
               </Item>
163
          </ForwardedToItems>
164
     </ForwardedTo>
165
     <ManufacturingArea>
166
          <ManufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

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

Name of manufacturing area

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

Manufacturing area reference

>{String}</ManufacturingAreaLink>
169
     </ManufacturingArea>
170
     <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

>
171
          <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>
172
     </CostOverrun>
173
     <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

>
174
          <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>
175
     </TimeOverrun>
176
     <Management>
177
          <ProjectLeader
ProjectLeader

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

>
178
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
182
          </ProjectLeader>
183
          <DocumentController
DocumentController

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

>
184
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
188
          </DocumentController>
189
     </Management>
190
</ProductionWorkOrder>
1
{
2
     "productionWorkOrder": {
3
          "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

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

Status of production work order

Possible domain values can be found here

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

Type of production work order

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
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
9
          "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}",
10
          "netWeight
NetWeight

The net weight of object (excluding packing meterial) in kilograms

": "{Decimal}",
11
          "requestedCompletionDate
RequestedCompletionDate

The requested date of completion for the production work order.

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

The confirmed date of completion for the production work order

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

If true, confirmed delivery date is locked.

": "{Boolean}",
14
          "productRevision
ProductRevision

Product revision used for this production work order

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

The quantity that will be (or has been) produced

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

Scheduled/planned date of production start

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

Scheduled/planned date of production completion

": "{Date}",
18
          "estimatedStartDate
EstimatedStartDate

Production work order estimated start date

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

Remaining number of units to produce

": "{Decimal}",
20
          "potentialProductionQuantity
PotentialProductionQuantity

Number of products possible to produce with the current stock.

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

True if production has supply shortage (negative metarial trend)

": "{Boolean}",
22
          "materialDelayedDays
MaterialDelayedDays

Number of days that material for the PWO is delayed.

": "{Integer}",
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
          "isRework
IsRework

Is Pwroduction Work Order a rework production

": "{Boolean}",
26
          "customersReference
CustomersReference

Customer reference

": "{String}",
27
          "latestStartAt
LatestStartAt

Latest possibile date of starting production

": "{Datetime}",
28
          "availableQuantity
AvailableQuantity

The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned.

": "{Decimal}",
29
          "availableQuantityInPercent
AvailableQuantityInPercent

Remaining production available percent

": "{Decimal}",
30
          "hasProcessRunning
HasProcessRunning

Is Production Work Order is beeing currenlty processed by internal process

": "{Boolean}",
31
          "isInFaultyState
IsInFaultyState

A flag to indicate if production work order is in faulty state (the work on the document should not be continueed until production work order got corrected)

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

Has replace before production material

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

Is Production Work Order is batch type production

": "{Boolean}",
34
          "isBlockedForProduction
IsBlockedForProduction

Is Production Work Order blocked for production

": "{Boolean}",
35
          "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

": "{String}",
36
          "hasStandardStructure
HasStandardStructure

Production Work Order has customers structure

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

Name of production work order item

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

Planning category

Possible domain values can be found here

": "{String}",
39
          "productUnitMarkingSpecification
ProductUnitMarkingSpecification

Describes how to mark the product unit

": "{String}",
40
          "onHold": {
41
               "isOnHold
IsOnHold

Flag to indicate if production work order is on hold

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

Date of putting production work order on hold

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

Date and time production work order should be on hold to

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

A category of production work order on hold reason

Possible domain values can be found here

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

A side responsible for causing production work order on hold

Possible domain values can be found here

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

Reason of putting production work order on hold

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

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

": {
48
                    "userId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

": "{String}"
52
               }
53
          },
54
          "productionFor": {
55
               "database
Database

Database of the object

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

Item-number of the object

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

Type of item

": "{String}",
58
               "object": {
59
                    "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
61
                    "customer": {
62
                         "customerId
CustomerId

Customer identifier

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

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

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

Customer reference

": "{String}"
65
                    },
66
                    "objectLink
ObjectLink

API reference to the object

": "{String}"
67
               },
68
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}",
70
               "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmation date from linked order

": "{Date}"
71
          },
72
          "location
Location

The location of the production.

": {
73
               "locationId
LocationId

Location identifier

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

": "{Integer}",
74
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
75
               "locationLink
LocationLink

Location reference

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

": "{String}"
76
          },
77
          "measurementUnit": {
78
               "measurementUnitId
MeasurementUnitId

Material unit reference

": "{Integer}",
79
               "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",
80
               "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
81
          },
82
          "product": {
83
               "productId
ProductId

Product identifier

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

Name of the product

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

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

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

Type of product

Possible domain values can be found here

": "{String}",
87
               "countryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

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

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

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

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

": "{String}",
90
               "dimensions": {
91
                    "weight
Weight

The weight of the product in kilograms.

": "{Decimal}"
92
               },
93
               "manufacturer": {
94
                    "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
95
                    "shortName
ShortName

Shortname/code of the manufacturer

": "{String}",
96
                    "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
97
               },
98
               "productClassification": {
99
                    "productClassificationId
ProductClassificationId

Product classification identifier

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

Product classification reference

": "{String}"
101
               },
102
               "productLink
ProductLink

Product reference

": "{String}"
103
          },
104
          "price": {
105
               "grossPrice
GrossPrice

Production Work Order article price

": "{Decimal}",
106
               "currency
Currency

Production Work Order article prices currency

": "{String}"
107
          },
108
          "productStructure": {
109
               "productStructureId
ProductStructureId

Product structure reference

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

Product structure reference

": "{String}"
111
          },
112
          "financeProject": {
113
               "financeProjectId
FinanceProjectId

Finance project identifier

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

Name of finance project

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

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

Finance project reference

": "{String}"
116
          },
117
          "salesDeliveryProject
SalesDeliveryProject

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

": {
118
               "salesDeliveryProjectId
SalesDeliveryProjectId

Sales delivery project identifier

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

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

Name of sales delivery

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

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

Sales delivery project reference

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

": "{String}"
121
          },
122
          "department": {
123
               "departmentId
DepartmentId

Department identifier

": "{Integer}",
124
               "departmentLink
DepartmentLink

Finance department reference

": "{String}"
125
          },
126
          "productionPlanner": {
127
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
131
          },
132
          "initialWorkOrder
InitialWorkOrder

Initial Production Work Order that current work order originated from

": {
133
               "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

": "{Integer}",
134
               "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

": "{String}"
135
          },
136
          "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

": {
137
               "forwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

": "{Decimal}",
138
               "forwardedFromItem": {
139
                    "itemId
ItemId

Identifier of the object

": "{Integer}",
140
                    "object": {
141
                         "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

": "{String}"
144
                    },
145
                    "itemLink
ItemLink

API reference to the item

": "{String}"
146
               }
147
          },
148
          "scrap": {
149
               "isScrapped
IsScrapped

True, if element is being scrapped.

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

Reason for scrapping

Possible domain values can be found here

": "{Integer}"
151
          },
152
          "forwardedTo
ForwardedTo

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

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

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

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

": [
155
                    {
156
                         "itemId
ItemId

Identifier of the object

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

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

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

": {
158
                              "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

": "{String}"
161
                         },
162
                         "itemLink
ItemLink

API reference to the item

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

": "{String}"
163
                    }
164
               ]
165
          },
166
          "manufacturingArea": {
167
               "manufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

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

Name of manufacturing area

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

Manufacturing area reference

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

": {
172
               "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}"
173
          },
174
          "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

": {
175
               "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}"
176
          },
177
          "management": {
178
               "projectLeader
ProjectLeader

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

": {
179
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
183
               },
184
               "documentController
DocumentController

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

": {
185
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
189
               }
190
          }
191
     }
192
}

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

POST
Pick goods reception item
AOP/100109
POST
Undo pick
AOP/100110
POST
Split into multiple production work orders
Starts batch that splits WorkOrder. After the split there should be 1 WorkOrder for each element in the ARB-table, including the orginal WorkOrder. It Release input is TRUE, the orders is released for production.
AOP/100296
POST
Print product labels
AOP/100664
POST
Pick all from restricted stock locations
Pick all items from restricted stock locations
AOP/100695
POST
Complete service production work order
AOP/100785
POST
Forward to goods reception
AOP/100907
POST
Forward to goods reception and move to stock location
AOP/100908
POST
Confirm production work order
Confirms ProductionWorkOrder
AOP/100991
POST
Cancel production work order
Cancels the production work order
AOP/101001
POST
Recalculate cost
Recalculates production work order
AOP/101002
POST
Remove project from all items
Remove ProjectNo on production
AOP/101009
POST
Assign material to stock
AOP/101015
POST
Block for purchase
Block production work order for purchase
AOP/101016
POST
Release for purchase
Release for Purchase - on PWO
AOP/101017
POST
Unassign (delink) material from production work order
AOP/101018
POST
Lock production work order assignments
AOP/101019
POST
Lock production work order to customer
Sets SAR.ACCESS where PWO is MAINID to PWO.ENDCUSTOMERACCOUNT
AOP/101020
POST
Unlock production work order from customer
Undo Setting of SAR.ACCESS where PWO is MAINID to PWO.ENDCUSACCOUNT
AOP/101022
POST
Undo release of production work order
AOP/101025
POST
Extract to external planning system
Extract PWO to External Planning System
AOP/101030
POST
Change locking of confirmed completion date
Locks/unlocks production work order confirmed completion date
AOP/101045
POST
Clear has negative material trend
Clear the HASNEGATIVEMATERIALTREND flag on production work order
AOP/101047
POST
Assign (relink) material to backlog and stock
AOP/101087
POST
Print return material list
AOP/101088
POST
Undo scrapping
AOP/101089
POST
Copy info from product structure (KIT) as a printable message
AOP/101091
POST
Pick product
AOP/101172
POST
Release production work order
Release work order for production. In case of non batch production if LimitToSerialNumbers is empty all units will be released.
AOP/101218
POST
Change priority on production work order
AOP/101302
POST
Update serial number at product units
Update serial number at product units (LCMs)
AOP/101335
POST
On hold
Set production work order on hold
AOP/101376
POST
On hold off
Set production work order on hold off
AOP/101377
POST
Scrap and release
AOP/101378
POST
Lock to customer
Lock production work order to a customer
AOP/101438
POST
Split and forward to stock
Continuously forward to stock
AOP/101464
POST
Copy current structure to product
Copies the current structure manufactured in this production work order as the structure as manufactured product
AOP/101476
POST
Split production work order
Splits production work order
AOP/101573
POST
Assign serial numbers in ascending order
Assign serial numbers to related LCMs in ascending order
AOP/101686
POST
Connect BOM files to work order
Triggers a BAQ to copy files from connected orders DocBom file folder
AOP/101724
POST
Set faulty state
Turns on ISINFAULTYSTATE flag on PWO (the work on document should not be continueed until PWO got corrected)
AOP/101783
POST
Unset faulty state
Turns off ISINFAULTYSTATE flag on PWO
AOP/101784
POST
Prepare for scrappipng work order
Start scrapping s work order
AOP/101787
POST
Scrap multiple product units
Scraps selected production units from work order
AOP/101789

Possible error codes the response might return:

Error 102120 HTTP 404 Delivery project not found
Error 100055 HTTP 403 You have only admittance to your own objects