Production APIs
Create new Production Operation
| HTTP method | POST |
| URI | https://api.rambase.net/production/operations |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 3464, version 8 |
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.
Name
Required/mandatory field
Name of production operation
>{String}</Name>Type
Type of operation
Applicable domain values can be found here
This field is optional.
>{String}</Type>Description
Description of production operation
This field is optional.
>{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
Default value: False
This field is optional.
>{Boolean}</RequirePickingBeforeCompletion>RequireSerialNumberBeforeCompletion
If this is checked, then all items in the tracelist for all product units needs to have serial number assigned
Default value: False
This field is optional.
>{Boolean}</RequireSerialNumberBeforeCompletion>SetNextOperationReadyTrigger
This field is optional.
>Value
Value for degree of completion you require in order to automatically set next operation as ready
Minimum value: 0
This field is optional.
>{Decimal}</Value>Unit
Unit for degree of completion you require in order to automatically set next operation as ready
Applicable domain values can be found here
This field is optional.
>{String}</Unit>AppliesTo
Tells if the production operation applies to a production resource or production resource group
This field is optional.
>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>ObjectId
Identifier of the object
This field is optional.
>{String}</ObjectId>Processing
This field is optional.
>RunTime
Planned run time in hours for the production operation
Minimum value: 0
This field is optional.
>{Decimal}</RunTime>Changeover
This field is optional.
>SetUpTime
Planned setup time in hours for the production operation
Minimum value: 0
This field is optional.
>{Decimal}</SetUpTime>CleanUpTime
Planned cleanup time in hours for the production operation
Minimum value: 0
This field is optional.
>{Decimal}</CleanUpTime>Checkpoint
This field is optional.
>HasCheckpoint
Has the value of 1 if the production operation has a checkpoint set
Default value: False
This field is optional.
>{Boolean}</HasCheckpoint>Description
The checkpoint text
This field is optional.
>{String}</Description>ServiceInterval
This field is optional.
>ServiceIntervalId
Service interval identifier
Minimum value: 100000
This field is optional.
>{Integer}</ServiceIntervalId>Name
Required/mandatory field
Name of production operation
": "{String}",Type
Type of operation
Applicable domain values can be found here
This field is optional.
": "{String}",Description
Description of production operation
This field is optional.
": "{String}",RequirePickingBeforeCompletion
If this is checked, then all parts for this and preivous operations must be be picked before current operation can be completed
Default value: False
This field is optional.
": "{Boolean}",RequireSerialNumberBeforeCompletion
If this is checked, then all items in the tracelist for all product units needs to have serial number assigned
Default value: False
This field is optional.
": "{Boolean}",SetNextOperationReadyTrigger
This field is optional.
": {Value
Value for degree of completion you require in order to automatically set next operation as ready
Minimum value: 0
This field is optional.
": "{Decimal}",Unit
Unit for degree of completion you require in order to automatically set next operation as ready
Applicable domain values can be found here
This field is optional.
": "{String}"AppliesTo
Tells if the production operation applies to a production resource or production resource group
This field is optional.
": {ObjectType
Type of object
This field is optional.
": "{String}",ObjectId
Identifier of the object
This field is optional.
": "{String}"Processing
This field is optional.
": {RunTime
Planned run time in hours for the production operation
Minimum value: 0
This field is optional.
": "{Decimal}"Changeover
This field is optional.
": {SetUpTime
Planned setup time in hours for the production operation
Minimum value: 0
This field is optional.
": "{Decimal}",CleanUpTime
Planned cleanup time in hours for the production operation
Minimum value: 0
This field is optional.
": "{Decimal}"Checkpoint
This field is optional.
": {HasCheckpoint
Has the value of 1 if the production operation has a checkpoint set
Default value: False
This field is optional.
": "{Boolean}",Description
The checkpoint text
This field is optional.
": "{String}"ServiceInterval
This field is optional.
": {ServiceIntervalId
Service interval identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $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] |
| $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.
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 100089 HTTP 404 | Product not found |
| Error 100475 HTTP 400 | Project number is mandatory on all items. |
| Error 101488 HTTP 400 | Illegal general ledger account : {0} |
| Error 105186 HTTP 400 | Postings are not allowed on control accounts. |
| Error 101490 HTTP 400 | Illegal Account {0}: This account has been blocked for {1}-documents |
| Error 101491 HTTP 400 | Illegal Account {0}: Check the account's FromPeriod and ToPeriod |
| Error 101517 HTTP 400 | Illegal Account {0}: This account require ICTDB. |
| Error 102482 HTTP 400 | Department is required for general ledger account {0} |
| Error 102483 HTTP 400 | Finance project is required for general ledger account {0} |
| Error 102484 HTTP 400 | Asset is required for general ledger account {0} |
| Error 102485 HTTP 400 | Dimension {0} ({1}) is required for general ledger account {2} |
| Error 101313 HTTP 400 | Department number is not valid: {0} |
| Error 101320 HTTP 400 | The project number is not valid: {0} |
| Error 101500 HTTP 400 | Project {0} could not be used : Check project FromPeriod and ToPeriod. |
| Error 101501 HTTP 400 | Asset is not allowed on general ledger account {0} |
| Error 101326 HTTP 400 | The asset number is not valid : {0} |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |
| Error 106437 HTTP 400 | Type can not be changed when status is not equal to draft (status 1) |
| Error 101009 HTTP 400 | The product has a structure. You can only change the product type to a type that can contain a structure. |
| Error 101010 HTTP 400 | The product structure contains operations and can not be changed to become a phantom structure |
| Error 101008 HTTP 400 | Cannot change product type from a physical type to a virtual type |
| Error 101007 HTTP 400 | Cannot change product type from a virtual type to a physical type |
| Error 103021 HTTP 400 | Linkid must be a rental product |
| Error 104760 HTTP 400 | Costing method can't be changed after product has been received |
| Error 104652 HTTP 400 | Both minimum sales price and minimum sales price currency must be given |
| Error 100563 HTTP 400 | Currency {0} is not supported by the system |
| Error 104653 HTTP 400 | Minimum sales price can not be negative |
| Error 106506 HTTP 404 | Image not found |