Production APIs
List of planned production operations
HTTP method | GET |
URI | https://api.rambase.net/production/planned-operations |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Custom fields | Custom fields supported |
Successful HTTP status code | 200 |
API resource identifier | 3589, version 26 |
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.
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.
ContainingPlannedOperationUsageDate Date | Show all planned operations documents containing planned operation usage date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
IsOutsourced Boolean | A flag to indicate if production operation is outsourced. |
IsProcessingCompleted Boolean | True if processing is completed. |
OutsourcedPurchaseOrderSupplier Integer | RamBase supplier identifier. |
PlannedFinishedAt Datetime | Date and time planned to finish. Specified by the planned work order operation.. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
PlannedStartAt Datetime | Date and time planned to start. Specified by the planned work order operation.. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
ProductionResourceGroupId Integer | Production resource group identifier. |
ProductionResourceId Integer | Production resource identifier. |
ProductStructureOperationSequence Integer | Work order operation's task identifier. |
PurchaseOrderId Integer | Purchase order identifier. |
SourceObjectId String | Identifier of the object. |
SourceType String | Type of object. |
Status Integer | Production work order operation status. |
UpdatedAt Datetime | Date and time of update. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Read more about filters and sorting on how to use sortable parameters
ContainingPlannedOperationUsageDate Date | Show all planned operations documents containing planned operation usage date |
IsOutsourced Boolean | A flag to indicate if production operation is outsourced |
IsProcessingCompleted Boolean | True if processing is completed |
OutsourcedPurchaseOrderSupplier Integer | RamBase supplier identifier |
PlannedFinishedAt Datetime | Date and time planned to finish. Specified by the planned work order operation. |
PlannedStartAt Datetime | Date and time planned to start. Specified by the planned work order operation. |
ProductionResourceGroupId Integer | Production resource group identifier |
ProductionResourceId Integer | Production resource identifier |
ProductStructureOperationSequence Integer | Work order operation's task identifier |
PurchaseOrderId Integer | Purchase order identifier |
SourceObjectId String | Identifier of the object |
SourceType String | Type of object |
Status Integer | Production work order operation status |
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.
PlannedOperationId
Planned work order operation identifier
>{Integer}</PlannedOperationId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>PlannedStartAt
Date and time planned to start. Specified by the planned work order operation.
>{Datetime}</PlannedStartAt>PlannedFinishedAt
Date and time planned to finish. Specified by the planned work order operation.
>{Datetime}</PlannedFinishedAt>Quantity
Quantity of the work order operation
>{Decimal}</Quantity>HasPriority
Flag which indicates if Work Order Operation has been prioritized
>{Boolean}</HasPriority>IsLineProduction
True if this product is planned and manufactured in line production.
>{Boolean}</IsLineProduction>IsOperationLocked
Is locked, must not be moved. Can be due to inspection by external source.
>{Boolean}</IsOperationLocked>IsChanged
Is changed by Planning system and waiting to be updated in 'worklist' (WOO).
>{Boolean}</IsChanged>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>PlannedStartAtMargin
Critical days
>{Integer}</PlannedStartAtMargin>LatestStartAt
late start represents the latest an activity can start without affecting the planned production / project finish date
>{Datetime}</LatestStartAt>ProductStructureOperationId
Product structure operation identifier
>{Integer}</ProductStructureOperationId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>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>RunTime
Runtime of the product structure operation. Changeover time is not included here.
>{Decimal}</RunTime>SetupTime
Changeover pre/setup time in hours
>{Decimal}</SetupTime>CleanupTime
Changeover post/cleanup time in hours
>{Decimal}</CleanupTime>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>IsOutsourced
A flag to indicate if production operation is outsourced
>{Boolean}</IsOutsourced>ProductStructureId
Product structure identifier
>{Integer}</ProductStructureId>ProductStructureLink
Product structure reference
>{String}</ProductStructureLink>ProductStructureVersionId
Product structure identifier
>{Integer}</ProductStructureVersionId>ProductStructureVersionLink
Product structure reference
>{String}</ProductStructureVersionLink>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
>Database
Database of the object
>{String}</Database>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>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ProductionResourceGroupId
Production resource group identifier
>{Integer}</ProductionResourceGroupId>ProductionResourceGroupLink
Production resource group reference
>{String}</ProductionResourceGroupLink>ProductionResourceId
Production resource identifier
>{Integer}</ProductionResourceId>ProductionResourceLink
Production resource reference
>{String}</ProductionResourceLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>PurchaseOrderItemId
Item-/line-number of the purchase order
>{Integer}</PurchaseOrderItemId>PurchaseOrderId
Purchase order identifier
>{Integer}</PurchaseOrderId>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
Supplier reference
>{String}</SupplierLink>PurchaseOrderLink
Purchase order reference
>{String}</PurchaseOrderLink>PurchaseOrderItemLink
Purchase order item reference
>{String}</PurchaseOrderItemLink>PlannedOperationLink
Planned work order operation reference
>{String}</PlannedOperationLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>PlannedOperationId
Planned work order operation identifier
": "{Integer}",Status
Status of planned operation
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",PlannedStartAt
Date and time planned to start. Specified by the planned work order operation.
": "{Datetime}",PlannedFinishedAt
Date and time planned to finish. Specified by the planned work order operation.
": "{Datetime}",Quantity
Quantity of the work order operation
": "{Decimal}",HasPriority
Flag which indicates if Work Order Operation has been prioritized
": "{Boolean}",IsLineProduction
True if this product is planned and manufactured in line production.
": "{Boolean}",IsOperationLocked
Is locked, must not be moved. Can be due to inspection by external source.
": "{Boolean}",IsChanged
Is changed by Planning system and waiting to be updated in 'worklist' (WOO).
": "{Boolean}",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}",PlannedStartAtMargin
Critical days
": "{Integer}",LatestStartAt
late start represents the latest an activity can start without affecting the planned production / project finish date
": "{Datetime}",ProductStructureOperationId
Product structure operation identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",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}",RunTime
Runtime of the product structure operation. Changeover time is not included here.
": "{Decimal}"SetupTime
Changeover pre/setup time in hours
": "{Decimal}",CleanupTime
Changeover post/cleanup time in hours
": "{Decimal}"ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductionOperationLink
Production operation reference
": "{String}"IsOutsourced
A flag to indicate if production operation is outsourced
": "{Boolean}"ProductStructureId
Product structure identifier
": "{Integer}",ProductStructureLink
Product structure reference
": "{String}"ProductStructureVersionId
Product structure identifier
": "{Integer}",ProductStructureVersionLink
Product structure reference
": "{String}"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
": {Database
Database of the object
": "{String}",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}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}"ProductionResourceGroupId
Production resource group identifier
": "{Integer}",ProductionResourceGroupLink
Production resource group reference
": "{String}"ProductionResourceId
Production resource identifier
": "{Integer}",ProductionResourceLink
Production resource reference
": "{String}"EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"PurchaseOrderItemId
Item-/line-number of the purchase order
": "{Integer}",PurchaseOrderId
Purchase order identifier
": "{Integer}",SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier reference
": "{String}"PurchaseOrderLink
Purchase order reference
": "{String}"PurchaseOrderItemLink
Purchase order item reference
": "{String}"PlannedOperationLink
Planned work order operation reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 103366 HTTP 404 | Production resource group not found. |
Error 100207 HTTP 404 | Production resource not found {0} |