API

Production APIs

GET production/delivery-snapshots/{productionDeliverySnapshotId}/work-breakdown-structure

List of work breakdown structure (WBS) for production delivery

HTTP method GET
URI https://api.rambase.net/production/delivery-snapshots/{productionDeliverySnapshotId}/work-breakdown-structure
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionDeliverySnapshotId} Production delivery snapshot identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2282, 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.

Format:
1
1

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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

AccruedCost Decimal Accrued cost of WBS element.
AccruedHours Decimal Accrued time of WBS element.
Code String WBS code for the element.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DelayedDays Integer Delayed days of WBS element.
HasMaterialShortage Boolean True if production has supply shortage (negative metarial trend).
InvoicedAmount Decimal Invoiced amount of WBS element.
Name String Name of WBS element.
PercentCompleted Decimal User defined percent completed.
PlannedCost Decimal Planned cost of WBS element.
PlannedHours Decimal Planned time of WBS element.
ProductionWorkOrderDatabase String Company code/database the object belongs to.
ProductionWorkOrderId Integer Production work order identifier.
ProductionWorkOrderQuantity Decimal The quantity that will be (or has been) produced.
ProductionWorkOrderStatus Integer Status of production work order.
ProductStructureOperationId Integer Product structure operation identifier.
SalesOrderId Integer Sales order identifier.
SalesOrderItemId Integer Sales order item identifier.
SalesOrderItemRemainingAmount Decimal Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice.
SalesOrderItemStatus Integer Status of the sales order item (0-9).
SequenceNumber Integer Sequence number of the product structure operation. Unique within a product structure.
Type String Type of WBS element.
WBSElementId Integer Work breakdown structure element identifier.

Read more about filters and sorting on how to use sortable parameters

AccruedCost Decimal Accrued cost of WBS element
AccruedHours Decimal Accrued time of WBS element
Code String WBS code for the element
CreatedAt Datetime Date and time of creation
DelayedDays Integer Delayed days of WBS element
HasMaterialShortage Boolean True if production has supply shortage (negative metarial trend)
InvoicedAmount Decimal Invoiced amount of WBS element
Name String Name of WBS element
PercentCompleted Decimal User defined percent completed
PlannedCost Decimal Planned cost of WBS element
PlannedHours Decimal Planned time of WBS element
ProductionWorkOrderDatabase String Company code/database the object belongs to
ProductionWorkOrderId Integer Production work order identifier
ProductionWorkOrderQuantity Decimal The quantity that will be (or has been) produced
ProductionWorkOrderStatus Integer Status of production work order
ProductStructureOperationId Integer Product structure operation identifier
SalesOrderId Integer Sales order identifier
SalesOrderItemId Integer Sales order item identifier
SalesOrderItemRemainingAmount Decimal Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice
SalesOrderItemStatus Integer Status of the sales order item (0-9).
SequenceNumber Integer Sequence number of the product structure operation. Unique within a product structure.
Type String Type of WBS element
WBSElementId Integer Work breakdown structure element identifier

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.

Format:
1
<WBS>
2
     <WBSElement>
3
          <WBSElementId
WBSElementId

Work breakdown structure element identifier

>{Integer}</WBSElementId>
4
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
          <Code
Code

WBS code for the element

>{String}</Code>
6
          <Name
Name

Name of WBS element

>{String}</Name>
7
          <Type
Type

Type of WBS element

Possible domain values can be found here

>{String}</Type>
8
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
9
          <PercentCompleted
PercentCompleted

User defined percent completed

>{Decimal}</PercentCompleted>
10
          <CalculatedPercentCompleted
CalculatedPercentCompleted

Percent completed calculated by RamBase from completed work order operations.

>{Decimal}</CalculatedPercentCompleted>
11
          <AdvanceInvoicedAmount
AdvanceInvoicedAmount

Advance invoiced amount of WBS element

>{Decimal}</AdvanceInvoicedAmount>
12
          <InvoicedAmount
InvoicedAmount

Invoiced amount of WBS element

>{Decimal}</InvoicedAmount>
13
          <DelayedDays
DelayedDays

Delayed days of WBS element

>{Integer}</DelayedDays>
14
          <MaterialStatus
MaterialStatus

Status of the materials

Possible domain values can be found here

>{Integer}</MaterialStatus>
15
          <Planned>
16
               <Hours
Hours

Planned time of WBS element

>{Decimal}</Hours>
17
               <TotalCost
TotalCost

Planned cost of WBS element

>{Decimal}</TotalCost>
18
          </Planned>
19
          <Accrued>
20
               <Hours
Hours

Accrued time of WBS element

>{Decimal}</Hours>
21
               <TotalCost
TotalCost

Accrued cost of WBS element

>{Decimal}</TotalCost>
22
               <ActiveWorkOrdersCost
ActiveWorkOrdersCost

Production cost: Accrued cost for active work orders, PWO with ST<9.

>{Decimal}</ActiveWorkOrdersCost>
23
               <FinishedWorkOrdersCost
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>
24
               <ShippedWorkOrdersCost
ShippedWorkOrdersCost

Shipped cost: Accrued (real) cost for prod SSAs for COA items that are delivered, the CSA has ST>3

>{Decimal}</ShippedWorkOrdersCost>
25
          </Accrued>
26
          <Deviation
Deviation

Deviations calculated when the work order operation is completed

>
27
               <Hours
Hours

PRS1.TIMEDEVIATION

>{Decimal}</Hours>
28
               <HoursPercent
HoursPercent

PRS1.TIMEDEVIATIONPCT

>{Decimal}</HoursPercent>
29
               <TotalCost
TotalCost

PRS1.COSTDEVIATION. Only when finished.

>{Decimal}</TotalCost>
30
               <TotalCostPercent
TotalCostPercent

PRS1.COSTDEVIATIONPCT

>{Decimal}</TotalCostPercent>
31
          </Deviation>
32
          <SalesOrderItem
SalesOrderItem

The sales order item of the WBS element. Note that this is a snapshot back in time.

>
33
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
34
               <Status
Status

Status of the sales order item (0-9).

>{Integer}</Status>
35
               <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

>{Date}</RequestedDeliveryDate>
36
               <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery. Date of which the customer can expect the arriving goods

>{Date}</ConfirmedDeliveryDate>
37
               <Totals>
38
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
39
                    <RemainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

>{Decimal}</RemainingAmount>
40
               </Totals>
41
               <SalesOrder>
42
                    <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
43
                    <SalesOrderLink
SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>
44
               </SalesOrder>
45
               <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
46
          </SalesOrderItem>
47
          <ProductionWorkOrder
ProductionWorkOrder

Production work order for WBS element. Note that this is a snapshot back in time.

>
48
               <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
49
               <Database
Database

Company code/database the object belongs to

>{String}</Database>
50
               <Status
Status

Status of production work order

>{Integer}</Status>
51
               <Quantity
Quantity

The quantity that will be (or has been) produced

>{Decimal}</Quantity>
52
               <HasMaterialShortage
HasMaterialShortage

True if production has supply shortage (negative metarial trend)

>{Boolean}</HasMaterialShortage>
53
               <ConfirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

>{Date}</ConfirmedCompletionDate>
54
               <ScheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

>{Date}</ScheduledStartDate>
55
               <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>
56
          </ProductionWorkOrder>
57
          <WorkOrderOperation>
58
               <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

>{Integer}</WorkOrderOperationId>
59
               <Status
Status

Production work order operation status

Possible domain values can be found here

>{Integer}</Status>
60
               <WorkOrderOperationLink
WorkOrderOperationLink

Work order operation reference

>{String}</WorkOrderOperationLink>
61
          </WorkOrderOperation>
62
          <ProductStructureOperation>
63
               <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

>{Integer}</ProductStructureOperationId>
64
               <SequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

>{Integer}</SequenceNumber>
65
               <ProductStructure>
66
                    <ProductStructureId
ProductStructureId

Product structure identifier

>{Integer}</ProductStructureId>
67
                    <ProductStructureLink
ProductStructureLink

Product structure reference

>{String}</ProductStructureLink>
68
               </ProductStructure>
69
               <ProductStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

>{String}</ProductStructureOperationLink>
70
          </ProductStructureOperation>
71
          <WBSElementLink
WBSElementLink

Work breakdown structure element identifier

>{String}</WBSElementLink>
72
     </WBSElement>
73
     <Paging
Paging

Detailed paging information for this list.

>
74
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
75
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
76
          <Page
Page

Page index

>{Integer}</Page>
77
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
78
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
79
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
80
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
81
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
82
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
83
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
84
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
85
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
86
     </Paging>
87
</WBS>
1
{
2
     "wBS": [
3
          {
4
               "wBSElementId
WBSElementId

Work breakdown structure element identifier

": "{Integer}",
5
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
               "code
Code

WBS code for the element

": "{String}",
7
               "name
Name

Name of WBS element

": "{String}",
8
               "type
Type

Type of WBS element

Possible domain values can be found here

": "{String}",
9
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
10
               "percentCompleted
PercentCompleted

User defined percent completed

": "{Decimal}",
11
               "calculatedPercentCompleted
CalculatedPercentCompleted

Percent completed calculated by RamBase from completed work order operations.

": "{Decimal}",
12
               "advanceInvoicedAmount
AdvanceInvoicedAmount

Advance invoiced amount of WBS element

": "{Decimal}",
13
               "invoicedAmount
InvoicedAmount

Invoiced amount of WBS element

": "{Decimal}",
14
               "delayedDays
DelayedDays

Delayed days of WBS element

": "{Integer}",
15
               "materialStatus
MaterialStatus

Status of the materials

Possible domain values can be found here

": "{Integer}",
16
               "planned": {
17
                    "hours
Hours

Planned time of WBS element

": "{Decimal}",
18
                    "totalCost
TotalCost

Planned cost of WBS element

": "{Decimal}"
19
               },
20
               "accrued": {
21
                    "hours
Hours

Accrued time of WBS element

": "{Decimal}",
22
                    "totalCost
TotalCost

Accrued cost of WBS element

": "{Decimal}",
23
                    "activeWorkOrdersCost
ActiveWorkOrdersCost

Production cost: Accrued cost for active work orders, PWO with ST<9.

": "{Decimal}",
24
                    "finishedWorkOrdersCost
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}",
25
                    "shippedWorkOrdersCost
ShippedWorkOrdersCost

Shipped cost: Accrued (real) cost for prod SSAs for COA items that are delivered, the CSA has ST>3

": "{Decimal}"
26
               },
27
               "deviation
Deviation

Deviations calculated when the work order operation is completed

": {
28
                    "hours
Hours

PRS1.TIMEDEVIATION

": "{Decimal}",
29
                    "hoursPercent
HoursPercent

PRS1.TIMEDEVIATIONPCT

": "{Decimal}",
30
                    "totalCost
TotalCost

PRS1.COSTDEVIATION. Only when finished.

": "{Decimal}",
31
                    "totalCostPercent
TotalCostPercent

PRS1.COSTDEVIATIONPCT

": "{Decimal}"
32
               },
33
               "salesOrderItem
SalesOrderItem

The sales order item of the WBS element. Note that this is a snapshot back in time.

": {
34
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
35
                    "status
Status

Status of the sales order item (0-9).

": "{Integer}",
36
                    "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

": "{Date}",
37
                    "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery. Date of which the customer can expect the arriving goods

": "{Date}",
38
                    "totals": {
39
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
40
                         "remainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

": "{Decimal}"
41
                    },
42
                    "salesOrder": {
43
                         "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
44
                         "salesOrderLink
SalesOrderLink

Sales order reference

": "{String}"
45
                    },
46
                    "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
47
               },
48
               "productionWorkOrder
ProductionWorkOrder

Production work order for WBS element. Note that this is a snapshot back in time.

": {
49
                    "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

": "{Integer}",
50
                    "database
Database

Company code/database the object belongs to

": "{String}",
51
                    "status
Status

Status of production work order

": "{Integer}",
52
                    "quantity
Quantity

The quantity that will be (or has been) produced

": "{Decimal}",
53
                    "hasMaterialShortage
HasMaterialShortage

True if production has supply shortage (negative metarial trend)

": "{Boolean}",
54
                    "confirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

": "{Date}",
55
                    "scheduledStartDate
ScheduledStartDate

Scheduled/planned date of production start

": "{Date}",
56
                    "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

": "{String}"
57
               },
58
               "workOrderOperation": {
59
                    "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

": "{Integer}",
60
                    "status
Status

Production work order operation status

Possible domain values can be found here

": "{Integer}",
61
                    "workOrderOperationLink
WorkOrderOperationLink

Work order operation reference

": "{String}"
62
               },
63
               "productStructureOperation": {
64
                    "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

": "{Integer}",
65
                    "sequenceNumber
SequenceNumber

Sequence number of the product structure operation. Unique within a product structure.

": "{Integer}",
66
                    "productStructure": {
67
                         "productStructureId
ProductStructureId

Product structure identifier

": "{Integer}",
68
                         "productStructureLink
ProductStructureLink

Product structure reference

": "{String}"
69
                    },
70
                    "productStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

": "{String}"
71
               },
72
               "wBSElementLink
WBSElementLink

Work breakdown structure element identifier

": "{String}"
73
          }
74
     ],
75
     "paging
Paging

Detailed paging information for this list.

": {
76
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
77
          "position
Position

Position of the first element in the list

": "{Integer}",
78
          "page
Page

Page index

": "{Integer}",
79
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
80
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
81
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
82
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
83
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
84
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
85
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
86
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
87
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
88
     }
89
}

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 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects