API

Production APIs

GET production/planned-operations/{plannedOperationId}

Planned operation details for provided identifier

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

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
<PlannedOperation>
2
     <PlannedOperationId
PlannedOperationId

Planned work order operation identifier

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

Status of planned operation

Possible domain values can be found here

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

Date and time of creation

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

Date and time of update

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

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

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

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

>{Datetime}</PlannedFinishedAt>
8
     <Quantity
Quantity

Quantity of the work order operation

>{Decimal}</Quantity>
9
     <HasPriority
HasPriority

Flag which indicates if Work Order Operation has been prioritized

>{Boolean}</HasPriority>
10
     <IsLineProduction
IsLineProduction

True if this product is planned and manufactured in line production.

>{Boolean}</IsLineProduction>
11
     <IsOperationLocked
IsOperationLocked

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

>{Boolean}</IsOperationLocked>
12
     <IsChanged
IsChanged

Is changed by Planning system and waiting to be updated in 'worklist' (WOO).

>{Boolean}</IsChanged>
13
     <IsPendingExternalPlanning
IsPendingExternalPlanning

Is transfered to Planning system and the operation is waiting for update from the planning system. This does only apply if the setting 'Wait for external planner to start operation' is on. PWOs with one or more operations with this flag on can not be released for production unless the flag is set to 0 for the operations in the PWOCRITICALDATE (operations list) application at the PWO.|

>{Boolean}</IsPendingExternalPlanning>
14
     <PlannedStartAtMargin
PlannedStartAtMargin

Critical days

>{Integer}</PlannedStartAtMargin>
15
     <LatestStartAt
LatestStartAt

late start represents the latest an activity can start without affecting the planned production / project finish date

>{Datetime}</LatestStartAt>
16
     <ProductStructureOperation>
17
          <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

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

>{Integer}</SequenceNumber>
19
          <WaitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

>{Decimal}</WaitTime>
20
          <Processing>
21
               <RunTime
RunTime

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

>{Decimal}</RunTime>
22
          </Processing>
23
          <Changeover>
24
               <SetupTime
SetupTime

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

>{Decimal}</CleanupTime>
26
          </Changeover>
27
          <ProductionOperation>
28
               <ProductionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

>{String}</ProductionOperationLink>
31
          </ProductionOperation>
32
          <OutsourcedOperation>
33
               <IsOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

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

Material lead time in days for external operations

>{Integer}</LeadTime>
35
          </OutsourcedOperation>
36
          <ProductStructure>
37
               <ProductStructureId
ProductStructureId

Product structure identifier

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

Product structure reference

>{String}</ProductStructureLink>
39
          </ProductStructure>
40
          <ProductStructureVersion>
41
               <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

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

Product structure reference

>{String}</ProductStructureVersionLink>
43
          </ProductStructureVersion>
44
     </ProductStructureOperation>
45
     <Source
Source

The document who is the source this element. In this version it is a WordOrder document, but in future implementations it could be other document types that have tasks and need planning

>
46
          <Database
Database

Database of the object

>{String}</Database>
47
          <IsCompleted
IsCompleted

Set when the source process is completed. (If the source process is a work order - then set if the work order is completed.

>{Boolean}</IsCompleted>
48
          <Object>
49
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>{String}</ObjectLink>
52
          </Object>
53
     </Source>
54
     <ProductionResourceGroup>
55
          <ProductionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

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

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

Production resource group reference

>{String}</ProductionResourceGroupLink>
58
     </ProductionResourceGroup>
59
     <ProductionResource>
60
          <ProductionResourceId
ProductionResourceId

Production resource identifier

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

Name of production resource

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

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

Production resource reference

>{String}</ProductionResourceLink>
63
     </ProductionResource>
64
     <Planner>
65
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
66
          <Name
Name

Last name of employee

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

>{String}</Name>
67
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
68
     </Planner>
69
     <OutsourcedOperationPurchaseOrderItem>
70
          <PurchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

>{Integer}</PurchaseOrderItemId>
71
          <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

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

>{Date}</RequestedDeliveryDate>
72
          <ScheduledShippingDateToSupplier
ScheduledShippingDateToSupplier

Shceduled date of shipping goods or material to supplier for external work.

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

>{Date}</ScheduledShippingDateToSupplier>
73
          <PurchaseOrder>
74
               <PurchaseOrderId
PurchaseOrderId

Purchase order identifier

>{Integer}</PurchaseOrderId>
75
               <Supplier>
76
                    <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
77
                    <Name
Name

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

>{String}</Name>
78
                    <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
79
               </Supplier>
80
               <PurchaseOrderLink
PurchaseOrderLink

Purchase order reference

>{String}</PurchaseOrderLink>
81
          </PurchaseOrder>
82
          <PurchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

>{String}</PurchaseOrderItemLink>
83
     </OutsourcedOperationPurchaseOrderItem>
84
     <OutsourcedOperationPurchaseOrderResponseItem
OutsourcedOperationPurchaseOrderResponseItem

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

>
85
          <PurchaseOrderResponseItemId
PurchaseOrderResponseItemId

Item-/linenumber of purchase order response

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

>{Integer}</PurchaseOrderResponseItemId>
86
          <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed delivery date

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

>{Date}</ConfirmedDeliveryDate>
87
          <PurchaseOrderResponse
PurchaseOrderResponse

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

>
88
               <PurchaseOrderResponseId
PurchaseOrderResponseId

Purchase order response identifier

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

>{Integer}</PurchaseOrderResponseId>
89
          </PurchaseOrderResponse>
90
          <PurchaseOrderResponseItemLink
PurchaseOrderResponseItemLink

Purchase order response item reference

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

>{String}</PurchaseOrderResponseItemLink>
91
     </OutsourcedOperationPurchaseOrderResponseItem>
92
     <WorkOrderOperation
WorkOrderOperation

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

>
93
          <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

>{Integer}</WorkOrderOperationId>
94
          <WorkOrderOperationLink
WorkOrderOperationLink

Work order operation reference

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

>{String}</WorkOrderOperationLink>
95
          <ProductionWorkOrder
ProductionWorkOrder

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

>
96
               <ManufacturedProductName
ManufacturedProductName

Name of production work order item

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

>{String}</ManufacturedProductName>
97
          </ProductionWorkOrder>
98
     </WorkOrderOperation>
99
     <NumberOfScheduledTaskProcesses
NumberOfScheduledTaskProcesses

Number of scheduled production task processes for planned operation

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

>{Integer}</NumberOfScheduledTaskProcesses>
100
</PlannedOperation>
1
{
2
     "plannedOperation": {
3
          "plannedOperationId
PlannedOperationId

Planned work order operation identifier

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

Status of planned operation

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

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

Date and time of update

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

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

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

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

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

Quantity of the work order operation

": "{Decimal}",
10
          "hasPriority
HasPriority

Flag which indicates if Work Order Operation has been prioritized

": "{Boolean}",
11
          "isLineProduction
IsLineProduction

True if this product is planned and manufactured in line production.

": "{Boolean}",
12
          "isOperationLocked
IsOperationLocked

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

": "{Boolean}",
13
          "isChanged
IsChanged

Is changed by Planning system and waiting to be updated in 'worklist' (WOO).

": "{Boolean}",
14
          "isPendingExternalPlanning
IsPendingExternalPlanning

Is transfered to Planning system and the operation is waiting for update from the planning system. This does only apply if the setting 'Wait for external planner to start operation' is on. PWOs with one or more operations with this flag on can not be released for production unless the flag is set to 0 for the operations in the PWOCRITICALDATE (operations list) application at the PWO.|

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

Critical days

": "{Integer}",
16
          "latestStartAt
LatestStartAt

late start represents the latest an activity can start without affecting the planned production / project finish date

": "{Datetime}",
17
          "productStructureOperation": {
18
               "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

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

": "{Integer}",
20
               "waitTime
WaitTime

The wait time is used to specify if the products needs to wait before continuing to the next operation. A typical example is the time required for drying after the application of paint. The wait time is specified in hours.

": "{Decimal}",
21
               "processing": {
22
                    "runTime
RunTime

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

": "{Decimal}"
23
               },
24
               "changeover": {
25
                    "setupTime
SetupTime

Changeover pre/setup time in hours

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

Changeover post/cleanup time in hours

": "{Decimal}"
27
               },
28
               "productionOperation": {
29
                    "productionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

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

Production operation reference

": "{String}"
32
               },
33
               "outsourcedOperation": {
34
                    "isOutsourced
IsOutsourced

A flag to indicate if production operation is outsourced

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

Material lead time in days for external operations

": "{Integer}"
36
               },
37
               "productStructure": {
38
                    "productStructureId
ProductStructureId

Product structure identifier

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

Product structure reference

": "{String}"
40
               },
41
               "productStructureVersion": {
42
                    "productStructureVersionId
ProductStructureVersionId

Product structure identifier

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

Product structure reference

": "{String}"
44
               }
45
          },
46
          "source
Source

The document who is the source this element. In this version it is a WordOrder document, but in future implementations it could be other document types that have tasks and need planning

": {
47
               "database
Database

Database of the object

": "{String}",
48
               "isCompleted
IsCompleted

Set when the source process is completed. (If the source process is a work order - then set if the work order is completed.

": "{Boolean}",
49
               "object": {
50
                    "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

": "{String}"
53
               }
54
          },
55
          "productionResourceGroup": {
56
               "productionResourceGroupId
ProductionResourceGroupId

Production resource group identifier

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

Name of production resource group

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

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

Production resource group reference

": "{String}"
59
          },
60
          "productionResource": {
61
               "productionResourceId
ProductionResourceId

Production resource identifier

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

Name of production resource

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

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

Production resource reference

": "{String}"
64
          },
65
          "planner": {
66
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

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

Employee reference

": "{String}"
69
          },
70
          "outsourcedOperationPurchaseOrderItem": {
71
               "purchaseOrderItemId
PurchaseOrderItemId

Item-/line-number of the purchase order

": "{Integer}",
72
               "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the buyer/purchaser

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

": "{Date}",
73
               "scheduledShippingDateToSupplier
ScheduledShippingDateToSupplier

Shceduled date of shipping goods or material to supplier for external work.

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

": "{Date}",
74
               "purchaseOrder": {
75
                    "purchaseOrderId
PurchaseOrderId

Purchase order identifier

": "{Integer}",
76
                    "supplier": {
77
                         "supplierId
SupplierId

RamBase supplier identifier

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

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

": "{String}",
79
                         "supplierLink
SupplierLink

Supplier reference

": "{String}"
80
                    },
81
                    "purchaseOrderLink
PurchaseOrderLink

Purchase order reference

": "{String}"
82
               },
83
               "purchaseOrderItemLink
PurchaseOrderItemLink

Purchase order item reference

": "{String}"
84
          },
85
          "outsourcedOperationPurchaseOrderResponseItem
OutsourcedOperationPurchaseOrderResponseItem

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

": {
86
               "purchaseOrderResponseItemId
PurchaseOrderResponseItemId

Item-/linenumber of purchase order response

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

": "{Integer}",
87
               "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed delivery date

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

": "{Date}",
88
               "purchaseOrderResponse
PurchaseOrderResponse

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

": {
89
                    "purchaseOrderResponseId
PurchaseOrderResponseId

Purchase order response identifier

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

": "{Integer}"
90
               },
91
               "purchaseOrderResponseItemLink
PurchaseOrderResponseItemLink

Purchase order response item reference

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

": "{String}"
92
          },
93
          "workOrderOperation
WorkOrderOperation

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

": {
94
               "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

": "{Integer}",
95
               "workOrderOperationLink
WorkOrderOperationLink

Work order operation reference

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

": "{String}",
96
               "productionWorkOrder
ProductionWorkOrder

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

": {
97
                    "manufacturedProductName
ManufacturedProductName

Name of production work order item

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

": "{String}"
98
               }
99
          },
100
          "numberOfScheduledTaskProcesses
NumberOfScheduledTaskProcesses

Number of scheduled production task processes for planned operation

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

": "{Integer}"
101
     }
102
}

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 101119 HTTP 404 Shipping service was not found
Error 100053 HTTP 403 You have only admittance to your own suppliers