Product APIs
API resource to update product structure operation
| HTTP method | PUT |
| URI | https://api.rambase.net/product/structure-versions/{productStructureVersionId}/operations/{productStructureOperationId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productStructureVersionId} |
Product structure identifier
Integer, minimum 100000 |
| - URI parameter {productStructureOperationId} |
Product structure operation identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 7084, version 11 |
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.
ProductStructureOperation
This field is optional.
>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
Minimum value: 1
This field is optional.
>{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>ProductionOperation
This field is optional.
>RequirePickingBeforeCompletion
If this is checked, then all parts for this and preivous operations must be be picked before current operation can be completed
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
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
This field is optional.
>{String}</Unit>Checkpoint
This field is optional.
>HasCheckpoint
Has the value of 1 if the production operation has a checkpoint set
This field is optional.
>{Boolean}</HasCheckpoint>Description
The checkpoint text
This field is optional.
>{String}</Description>OutsourcedOperation
This field is optional.
>Note
Purchase order note for external operation, copied to the Note field at PO item
This field is optional.
>{String}</Note>IsPerformedOnSite
Flag to indicate if product structure's operation is performed in house
This field is optional.
>{Boolean}</IsPerformedOnSite>UnitPrice
Unit price of outsource operation
This field is optional.
>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</Currency>NetPrice
Net price for external operation
Minimum value: 0
This field is optional.
>{Decimal}</NetPrice>ProductStructureOperation
This field is optional.
": {SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
Minimum value: 1
This field is optional.
": "{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}"ProductionOperation
This field is optional.
": {RequirePickingBeforeCompletion
If this is checked, then all parts for this and preivous operations must be be picked before current operation can be completed
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
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
This field is optional.
": "{String}"Checkpoint
This field is optional.
": {HasCheckpoint
Has the value of 1 if the production operation has a checkpoint set
This field is optional.
": "{Boolean}",Description
The checkpoint text
This field is optional.
": "{String}"OutsourcedOperation
This field is optional.
": {Note
Purchase order note for external operation, copied to the Note field at PO item
This field is optional.
": "{String}",IsPerformedOnSite
Flag to indicate if product structure's operation is performed in house
This field is optional.
": "{Boolean}",UnitPrice
Unit price of outsource operation
This field is optional.
": {Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}",NetPrice
Net price for external operation
Minimum value: 0
This field is optional.
": "{Decimal}"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. |
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.
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 101529 HTTP 400 | Pick {0} quantity needs to be greater than 0 |
| Error 103016 HTTP 400 | Maximum number of decimals allowed for quantity is {0} |
| Error 101492 HTTP 400 | Illegal VAT code: VAT value > 0 is not allowed on this document |
| Error 101493 HTTP 400 | Illegal update: New VAT code has VAT percentage different from old VAT code. |
| Error 101494 HTTP 400 | Illegal VAT code: Vat code and document has different VAT number |
| Error 101496 HTTP 400 | Illegal VAT code {0}: Check VAT FromPeriod and ToPeriod |
| Error 101495 HTTP 400 | Illegal VAT code: {0} |
| Error 107641 HTTP 400 | VAT code {0} has not an active VAT code setup |
| Error 100984 HTTP 400 | Illegal update. The General ledger posting has ST>4 |
| Error 100985 HTTP 400 | Illegal update. The General ledger posting has AGIO-calculation |
| Error 100047 HTTP 404 | Supplier not found |
| Error 101097 HTTP 404 | Given currency {0} mismatch with currencies of supplier {1} |