Product APIs
API resource to append a new product structure operation
| HTTP method | POST |
| URI | https://api.rambase.net/product/structure-versions/{productStructureVersionId}/operations |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productStructureVersionId} |
Product structure identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 7087, 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.
SequenceNumber
Required/mandatory field
Sequence number of the product structure operation. Unique within a product structure.
Minimum value: 1
>{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.
Minimum value: 0
This field is optional.
>{Decimal}</WaitTime>Note
Note for product structure operation
This field is optional.
>{String}</Note>NoteToOperator
Operation information to operator
This field is optional.
>{String}</NoteToOperator>Processing
This field is optional.
>RunTime
Runtime of the product structure operation. Changeover time is not included here.
Minimum value: 0
This field is optional.
>{Decimal}</RunTime>Changeover
This field is optional.
>SetupTime
Changeover pre/setup time in hours
Minimum value: 0
This field is optional.
>{Decimal}</SetupTime>CleanupTime
Changeover post/cleanup time in hours
Minimum value: 0
This field is optional.
>{Decimal}</CleanupTime>ManHours
This field is optional.
>TotalTime
Planned man hours for product structure operation
Minimum value: 0
This field is optional.
>{Decimal}</TotalTime>ProductionOperationId
Required/mandatory field
Production operation identifier
Minimum value: 1000
>{Integer}</ProductionOperationId>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>StartCheckpoint
This field is optional.
>HasCheckpoint
Has the value of 1 if the production operation has start checkpoint set
Default value: False
This field is optional.
>{Boolean}</HasCheckpoint>Description
Start checkpoint description
This field is optional.
>{String}</Description>SequenceNumber
Required/mandatory field
Sequence number of the product structure operation. Unique within a product structure.
Minimum value: 1
": "{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.
Minimum value: 0
This field is optional.
": "{Decimal}",Note
Note for product structure operation
This field is optional.
": "{String}",NoteToOperator
Operation information to operator
This field is optional.
": "{String}",Processing
This field is optional.
": {RunTime
Runtime of the product structure operation. Changeover time is not included here.
Minimum value: 0
This field is optional.
": "{Decimal}"Changeover
This field is optional.
": {SetupTime
Changeover pre/setup time in hours
Minimum value: 0
This field is optional.
": "{Decimal}",CleanupTime
Changeover post/cleanup time in hours
Minimum value: 0
This field is optional.
": "{Decimal}"ManHours
This field is optional.
": {TotalTime
Planned man hours for product structure operation
Minimum value: 0
This field is optional.
": "{Decimal}"ProductionOperationId
Required/mandatory field
Production operation identifier
Minimum value: 1000
": "{Integer}",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}"StartCheckpoint
This field is optional.
": {HasCheckpoint
Has the value of 1 if the production operation has start checkpoint set
Default value: False
This field is optional.
": "{Boolean}",Description
Start checkpoint description
This field is optional.
": "{String}"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] |
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.
ProductStructureOperationId
Product structure operation identifier
>{Integer}</ProductStructureOperationId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>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>Note
Note for product structure operation
>{String}</Note>NoteToOperator
Operation information to operator
>{String}</NoteToOperator>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>TotalTime
Planned man hours for product structure operation
>{Decimal}</TotalTime>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>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
>{String}</Unit>ProductId
Product identifier
>{String}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product identifier
>{String}</ProductLink>HasCheckpoint
Has the value of 1 if the production operation has a checkpoint set
>{Boolean}</HasCheckpoint>Description
The checkpoint text
>{String}</Description>HasCheckpoint
Has the value of 1 if the production operation has start checkpoint set
>{Boolean}</HasCheckpoint>Description
Start checkpoint description
>{String}</Description>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>IsOutsourced
A flag to indicate if production operation is outsourced
>{Boolean}</IsOutsourced>Note
Purchase order note for external operation, copied to the Note field at PO item
>{String}</Note>IsPerformedOnSite
Flag to indicate if product structure's operation is performed in house
>{Boolean}</IsPerformedOnSite>LeadTime
Material lead time in days for external operations
>{Integer}</LeadTime>UnitPrice
Unit price of outsource operation
>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NetPrice
Net price for external operation
>{Decimal}</NetPrice>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>ProductStructureOperationId
Product structure operation identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",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}",Note
Note for product structure operation
": "{String}",NoteToOperator
Operation information to operator
": "{String}",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}"TotalTime
Planned man hours for product structure operation
": "{Decimal}"ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",Type
Type of operation
Possible domain values can be found here
": "{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
": "{String}"ProductId
Product identifier
": "{String}",Name
Name of the product
": "{String}",ProductLink
Product identifier
": "{String}"HasCheckpoint
Has the value of 1 if the production operation has a checkpoint set
": "{Boolean}",Description
The checkpoint text
": "{String}"HasCheckpoint
Has the value of 1 if the production operation has start checkpoint set
": "{Boolean}",Description
Start checkpoint description
": "{String}"ProductionOperationLink
Production operation reference
": "{String}"IsOutsourced
A flag to indicate if production operation is outsourced
": "{Boolean}",Note
Purchase order note for external operation, copied to the Note field at PO item
": "{String}",IsPerformedOnSite
Flag to indicate if product structure's operation is performed in house
": "{Boolean}",LeadTime
Material lead time in days for external operations
": "{Integer}",UnitPrice
Unit price of outsource operation
": {Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NetPrice
Net price for external operation
": "{Decimal}"ProductionResourceGroupId
Production resource group identifier
": "{Integer}",ProductionResourceGroupLink
Production resource group reference
": "{String}"ProductionResourceId
Production resource identifier
": "{Integer}",ProductionResourceLink
Production resource 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 100247 HTTP 404 | Purchase quote not found |
| Error 101042 HTTP 400 | Purchase Quote Item is not valid. It is effetive from {0} |
| Error 101043 HTTP 400 | The Purchase Quote Item is expired |
| Error 101044 HTTP 400 | Purchase Quote Item expired on {0} |
| Error 101050 HTTP 400 | Purchase Quote Item quantity needs to be increased |
| Error 101045 HTTP 400 | The purchase quote item needs to be activated |
| Error 101401 HTTP 400 | The Ship and debit purchase quote must be in the same database as the stock assignment |
| Error 101047 HTTP 400 | The purchase quote item has too low available quantity |
| Error 101400 HTTP 400 | Supplier credit claim has been created from shipping advice |
| Error 106957 HTTP 400 | Only rental or subscription products can be used in recurring contract's lines |
| Error 105760 HTTP 400 | You cannot attach a recurring price to a sales order item |
| Error 106302 HTTP 404 | Product revision not found |
| Error 100047 HTTP 404 | Supplier not found |
| Error 101097 HTTP 404 | Given currency {0} mismatch with currencies of supplier {1} |