Production APIs
Production operation details for the provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/production/operations/{productionOperationId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productionOperationId} |
Production operation identifier
Integer, minimum 1000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 418, version 20 |
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 |
| $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.
ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Status
Status of production operation
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of production operation
>{String}</Name>Description
Description of production operation
>{String}</Description>RequirePickingBeforeCompletion
If this is checked, then all parts for this and preivous operations must be be picked before current operation can be completed
>{Boolean}</RequirePickingBeforeCompletion>RequireSerialNumberBeforeCompletion
If this is checked, then all items in the tracelist for all product units needs to have serial number assigned
>{Boolean}</RequireSerialNumberBeforeCompletion>Value
Value for degree of completion you require in order to automatically set next operation as ready
>{Decimal}</Value>Unit
Unit for degree of completion you require in order to automatically set next operation as ready
Possible domain values can be found here
>{String}</Unit>AppliesTo
Tells if the production operation applies to a production resource or production resource group
>ObjectType
Type of object
>{String}</ObjectType>ObjectId
Identifier of the object
>{String}</ObjectId>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>RunTime
Planned run time in hours for the production operation
>{Decimal}</RunTime>SetUpTime
Planned setup time in hours for the production operation
>{Decimal}</SetUpTime>CleanUpTime
Planned cleanup time in hours for the production operation
>{Decimal}</CleanUpTime>ProductForOutsourcedOperation
Product reference that is used when purchasing the outsourced production operation
>ProductId
Product identifier
>{String}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>HasCheckpoint
Has the value of 1 if the production operation has a checkpoint set
>{Boolean}</HasCheckpoint>Description
The checkpoint text
>{String}</Description>ServiceIntervalId
Service interval identifier
>{Integer}</ServiceIntervalId>Name
Name of the service interval
>{String}</Name>Value
Length/quantity/value of the interval
>{Decimal}</Value>ServiceIntervalLink
Service interval reference
>{String}</ServiceIntervalLink>ProductionOperationId
Production operation identifier
": "{Integer}",Status
Status of production operation
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name of production operation
": "{String}",Type
Type of operation
Possible domain values can be found here
": "{String}",Description
Description of production operation
": "{String}",RequirePickingBeforeCompletion
If this is checked, then all parts for this and preivous operations must be be picked before current operation can be completed
": "{Boolean}",RequireSerialNumberBeforeCompletion
If this is checked, then all items in the tracelist for all product units needs to have serial number assigned
": "{Boolean}",Value
Value for degree of completion you require in order to automatically set next operation as ready
": "{Decimal}",Unit
Unit for degree of completion you require in order to automatically set next operation as ready
Possible domain values can be found here
": "{String}"AppliesTo
Tells if the production operation applies to a production resource or production resource group
": {ObjectType
Type of object
": "{String}",ObjectId
Identifier of the object
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}"RunTime
Planned run time in hours for the production operation
": "{Decimal}"SetUpTime
Planned setup time in hours for the production operation
": "{Decimal}",CleanUpTime
Planned cleanup time in hours for the production operation
": "{Decimal}"ProductForOutsourcedOperation
Product reference that is used when purchasing the outsourced production operation
": {ProductId
Product identifier
": "{String}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"HasCheckpoint
Has the value of 1 if the production operation has a checkpoint set
": "{Boolean}",Description
The checkpoint text
": "{String}"ServiceIntervalId
Service interval identifier
": "{Integer}",Name
Name of the service interval
": "{String}",Value
Length/quantity/value of the interval
": "{Decimal}",Unit
Unit of the interval
Possible domain values can be found here
": "{String}"ServiceIntervalLink
Service interval reference
": "{String}"
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 103886 HTTP 404 | Service interval not found |