API

Production APIs

GET production/work-orders/{productionWorkOrderId}/work-breakdown-structure

List of all operations and sub-productions for provided production work order. Accrued and planned costs are added up from sub-productions to operations, and from operation to work orders.

HTTP method GET
URI https://api.rambase.net/production/work-orders/{productionWorkOrderId}/work-breakdown-structure
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionWorkOrderId} Production work order identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 3099, version 10

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.

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.

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

WBS code for the element

>{String}</Code>
4
          <MaterialStatus
MaterialStatus

Status of the materials

Possible domain values can be found here

>{Integer}</MaterialStatus>
5
          <ProductionWorkOrder>
6
               <ProductionWorkOrderId
ProductionWorkOrderId

Production work order identifier

>{Integer}</ProductionWorkOrderId>
7
               <Status
Status

Status of production work order

Possible domain values can be found here

>{Integer}</Status>
8
               <ReminingQuantity
ReminingQuantity

Remaining number of units to produce

>{Decimal}</ReminingQuantity>
9
               <ConfirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

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

Scheduled/planned date of production start

>{Date}</ScheduledStartDate>
11
               <HasMaterialShortage
HasMaterialShortage

True if production has supply shortage (negative metarial trend)

>{Boolean}</HasMaterialShortage>
12
               <Product>
13
                    <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
14
                    <Name
Name

Name of the product

>{String}</Name>
15
                    <Description
Description

Description of the product

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

>{String}</Description>
16
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
17
               </Product>
18
               <ProductionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

>{String}</ProductionWorkOrderLink>
19
          </ProductionWorkOrder>
20
          <ProductStructure>
21
               <ProductStructureId
ProductStructureId

Product structure identifier

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

Product structure reference

>{String}</ProductStructureLink>
23
          </ProductStructure>
24
          <ProductStructureOperation>
25
               <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

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

>{Integer}</SequenceNumber>
27
               <ProductionOperation>
28
                    <Name
Name

Name of production operation

>{String}</Name>
29
               </ProductionOperation>
30
               <ProductStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

>{String}</ProductStructureOperationLink>
31
          </ProductStructureOperation>
32
          <WorkOrderOperation
WorkOrderOperation

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

>
33
               <WorkOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

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

Production work order operation status

Possible domain values can be found here

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

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

Work order operation reference

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

>{String}</WorkOrderOperationLink>
36
          </WorkOrderOperation>
37
          <GoodsReceptionItem>
38
               <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
39
               <GoodsReception>
40
                    <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
41
                    <Status
Status

Status of the goods reception

Possible domain values can be found here

>{Integer}</Status>
42
                    <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

>{String}</GoodsReceptionLink>
43
               </GoodsReception>
44
               <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
45
          </GoodsReceptionItem>
46
          <Planned>
47
               <Hours
Hours

Total accrued hours for the delivery project

>{Decimal}</Hours>
48
               <MaterialCost
MaterialCost

SUMPLANNEDMATERIALCOST

>{Decimal}</MaterialCost>
49
               <FixedAdditionalCost
FixedAdditionalCost

SUMPLANNEDADDEDFIXEDCOST

>{Decimal}</FixedAdditionalCost>
50
               <VariableAdditionalCost
VariableAdditionalCost

SUMPLANNEDADDEDVARCOST

>{Decimal}</VariableAdditionalCost>
51
               <FixedOperationCost
FixedOperationCost

SUMPLANNEDOPERATIONFIXEDCOST

>{Decimal}</FixedOperationCost>
52
               <VariableOperationCost
VariableOperationCost

SUMPLANNEDOPERATIONVARCOST

>{Decimal}</VariableOperationCost>
53
          </Planned>
54
          <Accrued>
55
               <Hours
Hours

Total accrued hours for the delivery project

>{Decimal}</Hours>
56
               <MaterialCost
MaterialCost

SUMACCRUEDMATERIALCOST

>{Decimal}</MaterialCost>
57
               <FixedAdditionalCost
FixedAdditionalCost

SUMACCRUEDADDEDFIXEDCOST

>{Decimal}</FixedAdditionalCost>
58
               <VariableAdditionalCost
VariableAdditionalCost

SUMACCRUEDADDEDVARCOST

>{Decimal}</VariableAdditionalCost>
59
               <FixedOperationCost
FixedOperationCost

SUMACCRUEDOPERATIONFIXEDCOST

>{Decimal}</FixedOperationCost>
60
               <VariableOperationCost
VariableOperationCost

SUMACCRUEDOPERATIONVARCOST

>{Decimal}</VariableOperationCost>
61
          </Accrued>
62
          <Prognosis>
63
               <MaterialCost
MaterialCost

Sum of prognosis material cost for the complete production order structure, including material prognosis cost from all sub structures.

>{Decimal}</MaterialCost>
64
               <FixedAdditionalCost
FixedAdditionalCost

Sum of prognosis added fixed cost for the complete production order structure, including added fixed prognosis cost from all sub structures.

>{Decimal}</FixedAdditionalCost>
65
               <VariableAdditionalCost
VariableAdditionalCost

Sum of prognosis added variable cost for the complete production order structure, including added variable prognosis cost from all sub structures.

>{Decimal}</VariableAdditionalCost>
66
               <FixedOperationCost
FixedOperationCost

Sum of prognosis operation fixed cost for the complete production order structure, including operation fixed prognosis cost from all sub structures.

>{Decimal}</FixedOperationCost>
67
               <VariableOperationCost
VariableOperationCost

Sum of prognosis operation variable cost for the complete production order structure, including operation variable prognosis cost from all sub structures.

>{Decimal}</VariableOperationCost>
68
          </Prognosis>
69
     </WBSElement>
70
     <Paging
Paging

Detailed paging information for this list.

>
71
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
74
          <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>
75
          <FirstPage
FirstPage

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

>{String}</FirstPage>
76
          <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>
77
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
78
          <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>
79
          <NextPage
NextPage

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

>{String}</NextPage>
80
          <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>
81
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
83
     </Paging>
84
</WBS>
1
{
2
     "wBS": [
3
          {
4
               "code
Code

WBS code for the element

": "{String}",
5
               "materialStatus
MaterialStatus

Status of the materials

Possible domain values can be found here

": "{Integer}",
6
               "productionWorkOrder": {
7
                    "productionWorkOrderId
ProductionWorkOrderId

Production work order identifier

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

Status of production work order

Possible domain values can be found here

": "{Integer}",
9
                    "reminingQuantity
ReminingQuantity

Remaining number of units to produce

": "{Decimal}",
10
                    "confirmedCompletionDate
ConfirmedCompletionDate

The confirmed date of completion for the production work order

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

Scheduled/planned date of production start

": "{Date}",
12
                    "hasMaterialShortage
HasMaterialShortage

True if production has supply shortage (negative metarial trend)

": "{Boolean}",
13
                    "product": {
14
                         "productId
ProductId

Product identifier

": "{Integer}",
15
                         "name
Name

Name of the product

": "{String}",
16
                         "description
Description

Description of the product

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

": "{String}",
17
                         "productLink
ProductLink

Product reference

": "{String}"
18
                    },
19
                    "productionWorkOrderLink
ProductionWorkOrderLink

Production work order reference

": "{String}"
20
               },
21
               "productStructure": {
22
                    "productStructureId
ProductStructureId

Product structure identifier

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

Product structure reference

": "{String}"
24
               },
25
               "productStructureOperation": {
26
                    "productStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

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

": "{Integer}",
28
                    "productionOperation": {
29
                         "name
Name

Name of production operation

": "{String}"
30
                    },
31
                    "productStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

": "{String}"
32
               },
33
               "workOrderOperation
WorkOrderOperation

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

": {
34
                    "workOrderOperationId
WorkOrderOperationId

Production work order operation identifier

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

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

Production work order operation status

Possible domain values can be found here

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

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

Work order operation reference

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

": "{String}"
37
               },
38
               "goodsReceptionItem": {
39
                    "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
40
                    "goodsReception": {
41
                         "goodsReceptionId
GoodsReceptionId

Goods reception identifier

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

Status of the goods reception

Possible domain values can be found here

": "{Integer}",
43
                         "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

": "{String}"
44
                    },
45
                    "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
46
               },
47
               "planned": {
48
                    "hours
Hours

Total accrued hours for the delivery project

": "{Decimal}",
49
                    "materialCost
MaterialCost

SUMPLANNEDMATERIALCOST

": "{Decimal}",
50
                    "fixedAdditionalCost
FixedAdditionalCost

SUMPLANNEDADDEDFIXEDCOST

": "{Decimal}",
51
                    "variableAdditionalCost
VariableAdditionalCost

SUMPLANNEDADDEDVARCOST

": "{Decimal}",
52
                    "fixedOperationCost
FixedOperationCost

SUMPLANNEDOPERATIONFIXEDCOST

": "{Decimal}",
53
                    "variableOperationCost
VariableOperationCost

SUMPLANNEDOPERATIONVARCOST

": "{Decimal}"
54
               },
55
               "accrued": {
56
                    "hours
Hours

Total accrued hours for the delivery project

": "{Decimal}",
57
                    "materialCost
MaterialCost

SUMACCRUEDMATERIALCOST

": "{Decimal}",
58
                    "fixedAdditionalCost
FixedAdditionalCost

SUMACCRUEDADDEDFIXEDCOST

": "{Decimal}",
59
                    "variableAdditionalCost
VariableAdditionalCost

SUMACCRUEDADDEDVARCOST

": "{Decimal}",
60
                    "fixedOperationCost
FixedOperationCost

SUMACCRUEDOPERATIONFIXEDCOST

": "{Decimal}",
61
                    "variableOperationCost
VariableOperationCost

SUMACCRUEDOPERATIONVARCOST

": "{Decimal}"
62
               },
63
               "prognosis": {
64
                    "materialCost
MaterialCost

Sum of prognosis material cost for the complete production order structure, including material prognosis cost from all sub structures.

": "{Decimal}",
65
                    "fixedAdditionalCost
FixedAdditionalCost

Sum of prognosis added fixed cost for the complete production order structure, including added fixed prognosis cost from all sub structures.

": "{Decimal}",
66
                    "variableAdditionalCost
VariableAdditionalCost

Sum of prognosis added variable cost for the complete production order structure, including added variable prognosis cost from all sub structures.

": "{Decimal}",
67
                    "fixedOperationCost
FixedOperationCost

Sum of prognosis operation fixed cost for the complete production order structure, including operation fixed prognosis cost from all sub structures.

": "{Decimal}",
68
                    "variableOperationCost
VariableOperationCost

Sum of prognosis operation variable cost for the complete production order structure, including operation variable prognosis cost from all sub structures.

": "{Decimal}"
69
               }
70
          }
71
     ],
72
     "paging
Paging

Detailed paging information for this list.

": {
73
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
76
          "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}",
77
          "firstPage
FirstPage

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

": "{String}",
78
          "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}",
79
          "previousPage
PreviousPage

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

": "{String}",
80
          "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}",
81
          "nextPage
NextPage

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

": "{String}",
82
          "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}",
83
          "lastPage
LastPage

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

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

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

": "{Integer}"
85
     }
86
}

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 101013 HTTP 404 Sub-module not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}
Error 101420 HTTP 404 Setting definition not found