Production APIs
Details for provided work breakdown structure (WBS) element
| HTTP method | GET |
| URI | https://api.rambase.net/production/delivery-snapshots/{productionDeliverySnapshotId}/work-breakdown-structure/{wbsElementId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productionDeliverySnapshotId} |
Production delivery snapshot identifier
Integer, minimum 100000 |
| - URI parameter {wbsElementId} |
Work breakdown structure element identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 2272, version 9 |
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. |
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.
WBSElementId
Work breakdown structure element identifier
>{Integer}</WBSElementId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Code
WBS code for the element
>{String}</Code>Name
Name of WBS element
>{String}</Name>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>PercentCompleted
User defined percent completed
>{Decimal}</PercentCompleted>CalculatedPercentCompleted
Percent completed calculated by RamBase from completed work order operations.
>{Decimal}</CalculatedPercentCompleted>AdvanceInvoicedAmount
Advance invoiced amount of WBS element
>{Decimal}</AdvanceInvoicedAmount>InvoicedAmount
Invoiced amount of WBS element
>{Decimal}</InvoicedAmount>DelayedDays
Delayed days of WBS element
>{Integer}</DelayedDays>MaterialStatus
Status of the materials
Possible domain values can be found here
>{Integer}</MaterialStatus>Hours
Planned time of WBS element
>{Decimal}</Hours>TotalCost
Planned cost of WBS element
>{Decimal}</TotalCost>Hours
Accrued time of WBS element
>{Decimal}</Hours>TotalCost
Accrued cost of WBS element
>{Decimal}</TotalCost>ActiveWorkOrdersCost
Production cost: Accrued cost for active work orders, PWO with ST<9.
>{Decimal}</ActiveWorkOrdersCost>FinishedWorkOrdersCost
Cost finished productions: Real (accrued) cost for work orders that are forwarded to stock (PWO is forwarded to SSA) but where the SSA is still in stock, the COA item is not forwarded to a CSA that is shipped (ST>3)
>{Decimal}</FinishedWorkOrdersCost>ShippedWorkOrdersCost
Shipped cost: Accrued (real) cost for prod SSAs for COA items that are delivered, the CSA has ST>3
>{Decimal}</ShippedWorkOrdersCost>Deviation
Deviations calculated when the work order operation is completed
>Hours
PRS1.TIMEDEVIATION
>{Decimal}</Hours>HoursPercent
PRS1.TIMEDEVIATIONPCT
>{Decimal}</HoursPercent>TotalCost
PRS1.COSTDEVIATION. Only when finished.
>{Decimal}</TotalCost>TotalCostPercent
PRS1.COSTDEVIATIONPCT
>{Decimal}</TotalCostPercent>SalesOrderItem
The sales order item of the WBS element. Note that this is a snapshot back in time.
>SalesOrderItemId
Sales order item identifier
>{Integer}</SalesOrderItemId>Status
Status of the sales order item (0-9).
>{Integer}</Status>RequestedDeliveryDate
The delivery date as requested by the customer.
>{Date}</RequestedDeliveryDate>ConfirmedDeliveryDate
Confirmed date of delivery. Date of which the customer can expect the arriving goods
>{Date}</ConfirmedDeliveryDate>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
>{Decimal}</RemainingAmount>SalesOrderId
Sales order identifier
>{Integer}</SalesOrderId>SalesOrderLink
Sales order reference
>{String}</SalesOrderLink>SalesOrderItemLink
Reference to the sales order item.
>{String}</SalesOrderItemLink>ProductionWorkOrder
Production work order for WBS element. Note that this is a snapshot back in time.
>ProductionWorkOrderId
Production work order identifier
>{Integer}</ProductionWorkOrderId>Database
Company code/database the object belongs to
>{String}</Database>Status
Status of production work order
>{Integer}</Status>Quantity
The quantity that will be (or has been) produced
>{Decimal}</Quantity>HasMaterialShortage
True if production has supply shortage (negative metarial trend)
>{Boolean}</HasMaterialShortage>ConfirmedCompletionDate
The confirmed date of completion for the production work order
>{Date}</ConfirmedCompletionDate>ScheduledStartDate
Scheduled/planned date of production start
>{Date}</ScheduledStartDate>ProductionWorkOrderLink
Production work order reference
>{String}</ProductionWorkOrderLink>WorkOrderOperationId
Production work order operation identifier
>{Integer}</WorkOrderOperationId>Status
Production work order operation status
Possible domain values can be found here
>{Integer}</Status>WorkOrderOperationLink
Work order operation reference
>{String}</WorkOrderOperationLink>ProductStructureOperationId
Product structure operation identifier
>{Integer}</ProductStructureOperationId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>ProductStructureId
Product structure identifier
>{Integer}</ProductStructureId>ProductStructureLink
Product structure reference
>{String}</ProductStructureLink>ProductStructureOperationLink
Product structure operation reference
>{String}</ProductStructureOperationLink>WBSElementId
Work breakdown structure element identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Code
WBS code for the element
": "{String}",Name
Name of WBS element
": "{String}",Type
Type of WBS element
Possible domain values can be found here
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",PercentCompleted
User defined percent completed
": "{Decimal}",CalculatedPercentCompleted
Percent completed calculated by RamBase from completed work order operations.
": "{Decimal}",AdvanceInvoicedAmount
Advance invoiced amount of WBS element
": "{Decimal}",InvoicedAmount
Invoiced amount of WBS element
": "{Decimal}",DelayedDays
Delayed days of WBS element
": "{Integer}",MaterialStatus
Status of the materials
Possible domain values can be found here
": "{Integer}",Hours
Planned time of WBS element
": "{Decimal}",TotalCost
Planned cost of WBS element
": "{Decimal}"Hours
Accrued time of WBS element
": "{Decimal}",TotalCost
Accrued cost of WBS element
": "{Decimal}",ActiveWorkOrdersCost
Production cost: Accrued cost for active work orders, PWO with ST<9.
": "{Decimal}",FinishedWorkOrdersCost
Cost finished productions: Real (accrued) cost for work orders that are forwarded to stock (PWO is forwarded to SSA) but where the SSA is still in stock, the COA item is not forwarded to a CSA that is shipped (ST>3)
": "{Decimal}",ShippedWorkOrdersCost
Shipped cost: Accrued (real) cost for prod SSAs for COA items that are delivered, the CSA has ST>3
": "{Decimal}"Deviation
Deviations calculated when the work order operation is completed
": {Hours
PRS1.TIMEDEVIATION
": "{Decimal}",HoursPercent
PRS1.TIMEDEVIATIONPCT
": "{Decimal}",TotalCost
PRS1.COSTDEVIATION. Only when finished.
": "{Decimal}",TotalCostPercent
PRS1.COSTDEVIATIONPCT
": "{Decimal}"SalesOrderItem
The sales order item of the WBS element. Note that this is a snapshot back in time.
": {SalesOrderItemId
Sales order item identifier
": "{Integer}",Status
Status of the sales order item (0-9).
": "{Integer}",RequestedDeliveryDate
The delivery date as requested by the customer.
": "{Date}",ConfirmedDeliveryDate
Confirmed date of delivery. Date of which the customer can expect the arriving goods
": "{Date}",Currency
Three character code following the ISO 4217 standard
": "{String}",RemainingAmount
Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
": "{Decimal}"SalesOrderId
Sales order identifier
": "{Integer}",SalesOrderLink
Sales order reference
": "{String}"SalesOrderItemLink
Reference to the sales order item.
": "{String}"ProductionWorkOrder
Production work order for WBS element. Note that this is a snapshot back in time.
": {ProductionWorkOrderId
Production work order identifier
": "{Integer}",Database
Company code/database the object belongs to
": "{String}",Status
Status of production work order
": "{Integer}",Quantity
The quantity that will be (or has been) produced
": "{Decimal}",HasMaterialShortage
True if production has supply shortage (negative metarial trend)
": "{Boolean}",ConfirmedCompletionDate
The confirmed date of completion for the production work order
": "{Date}",ScheduledStartDate
Scheduled/planned date of production start
": "{Date}",ProductionWorkOrderLink
Production work order reference
": "{String}"WorkOrderOperationId
Production work order operation identifier
": "{Integer}",Status
Production work order operation status
Possible domain values can be found here
": "{Integer}",WorkOrderOperationLink
Work order operation reference
": "{String}"ProductStructureOperationId
Product structure operation identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",ProductStructureId
Product structure identifier
": "{Integer}",ProductStructureLink
Product structure reference
": "{String}"ProductStructureOperationLink
Product structure operation 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 102123 HTTP 404 | Production delivery snapshot not found |
| Error 102124 HTTP 404 | WBS element not found |