API

Product APIs

GET product/structure-versions/{productStructureVersionId}/materials?salesOrderId={salesOrderId}&salesOrderItemId={salesOrderItemId}

List of materials for provided product structure version

HTTP method GET
URI https://api.rambase.net/product/structure-versions/{productStructureVersionId}/materials?salesOrderId={salesOrderId}&salesOrderItemId={salesOrderItemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productStructureVersionId} Product structure identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 3962, version 16

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.

salesOrderId Integer, optional Sales order identifier

Minimum: 100000
salesOrderItemId Integer, optional Sales order item identifier

Minimum: 1
$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.

IsPendingExpiration Boolean A flag to indicate if product is end of life.
OperationSequenceNumber Integer Sequence number of the product structure operation. Unique within a product structure.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductStructureMaterialId Integer Product structure material identifier.
ProductType String Type of product.

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

IsPendingExpiration Boolean A flag to indicate if product is end of life
OperationSequenceNumber Integer Sequence number of the product structure operation. Unique within a product structure.
ProductId Integer Product identifier
ProductName String Name of the product
ProductStructureMaterialId Integer Product structure material identifier
ProductType String Type of product

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
<ProductStructureMaterials>
2
     <ProductStructureMaterial>
3
          <ProductStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

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

Date and time of creation

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

Needed material/part quantity in one unit of the product.|

>{Decimal}</Quantity>
6
          <Note
Note

Note for product structure version's material

>{String}</Note>
7
          <NeedsReplacementToRelease
NeedsReplacementToRelease

A flag to tell if this is a product which needs to be replaced in the production work order structure before releasing the production

>{Boolean}</NeedsReplacementToRelease>
8
          <WastagePercent
WastagePercent

Standard percentage of wastage for material when used in a production work order

>{Decimal}</WastagePercent>
9
          <CustomersReferenceNumber
CustomersReferenceNumber

A customer's reference number for product structure material

>{String}</CustomersReferenceNumber>
10
          <PlacementInstructionNote
PlacementInstructionNote

A product structure material's placement in the assembly

>{String}</PlacementInstructionNote>
11
          <Product>
12
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
16
               <LatestProductRevision>
17
                    <Revision
Revision

Revision number

>{String}</Revision>
18
               </LatestProductRevision>
19
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
20
          </Product>
21
          <ParentPhantomProduct>
22
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
23
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
24
          </ParentPhantomProduct>
25
          <ProductStructureOperation>
26
               <ProductStructureOperationId
ProductStructureOperationId

Product structure operation identifier

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

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

>{Integer}</SequenceNumber>
28
               <ProductionOperation>
29
                    <ProductionOperationId
ProductionOperationId

Production operation identifier

>{Integer}</ProductionOperationId>
30
                    <Name
Name

Name of production operation

>{String}</Name>
31
                    <ProductionOperationLink
ProductionOperationLink

Production operation reference

>{String}</ProductionOperationLink>
32
               </ProductionOperation>
33
               <ProductStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

>{String}</ProductStructureOperationLink>
34
          </ProductStructureOperation>
35
          <SubProductStructureVersion>
36
               <ProductStructureVersionId
ProductStructureVersionId

Product structure identifier

>{Integer}</ProductStructureVersionId>
37
          </SubProductStructureVersion>
38
          <LatestTenPreProductionTasks
LatestTenPreProductionTasks

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

>
39
               <Task
Task

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

>
40
                    <TaskId
TaskId

Unique task identifier

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

>{Integer}</TaskId>
41
                    <Type
Type

The type of the task

Possible domain values can be found here

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

>{String}</Type>
42
                    <Title
Title

The title/summary of the task

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

>{String}</Title>
43
                    <CreatedAt
CreatedAt

Date and time of creation

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

>{Datetime}</CreatedAt>
44
                    <Status
Status

The status of a task

Possible domain values can be found here

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

>{Integer}</Status>
45
                    <Priority
Priority

The priority of the task.

Possible domain values can be found here

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

>{Integer}</Priority>
46
                    <TaskLink
TaskLink

Task reference

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

>{String}</TaskLink>
47
               </Task>
48
          </LatestTenPreProductionTasks>
49
          <ProductStructureMaterialLink
ProductStructureMaterialLink

Product structure material reference

>{String}</ProductStructureMaterialLink>
50
     </ProductStructureMaterial>
51
     <Paging
Paging

Detailed paging information for this list.

>
52
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
55
          <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>
56
          <FirstPage
FirstPage

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

>{String}</FirstPage>
57
          <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>
58
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
59
          <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>
60
          <NextPage
NextPage

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

>{String}</NextPage>
61
          <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>
62
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
64
     </Paging>
65
</ProductStructureMaterials>
1
{
2
     "productStructureMaterials": [
3
          {
4
               "productStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

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

Date and time of creation

": "{Datetime}",
6
               "quantity
Quantity

Needed material/part quantity in one unit of the product.|

": "{Decimal}",
7
               "note
Note

Note for product structure version's material

": "{String}",
8
               "needsReplacementToRelease
NeedsReplacementToRelease

A flag to tell if this is a product which needs to be replaced in the production work order structure before releasing the production

": "{Boolean}",
9
               "wastagePercent
WastagePercent

Standard percentage of wastage for material when used in a production work order

": "{Decimal}",
10
               "customersReferenceNumber
CustomersReferenceNumber

A customer's reference number for product structure material

": "{String}",
11
               "placementInstructionNote
PlacementInstructionNote

A product structure material's placement in the assembly

": "{String}",
12
               "product": {
13
                    "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Type of product

Possible domain values can be found here

": "{String}",
17
                    "latestProductRevision": {
18
                         "revision
Revision

Revision number

": "{String}"
19
                    },
20
                    "productLink
ProductLink

Product reference

": "{String}"
21
               },
22
               "parentPhantomProduct": {
23
                    "productId
ProductId

Product identifier

": "{Integer}",
24
                    "productLink
ProductLink

Product reference

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

Product structure operation identifier

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

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

": "{Integer}",
29
                    "productionOperation": {
30
                         "productionOperationId
ProductionOperationId

Production operation identifier

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

Name of production operation

": "{String}",
32
                         "productionOperationLink
ProductionOperationLink

Production operation reference

": "{String}"
33
                    },
34
                    "productStructureOperationLink
ProductStructureOperationLink

Product structure operation reference

": "{String}"
35
               },
36
               "subProductStructureVersion": {
37
                    "productStructureVersionId
ProductStructureVersionId

Product structure identifier

": "{Integer}"
38
               },
39
               "latestTenPreProductionTasks
LatestTenPreProductionTasks

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

": [
40
                    {
41
                         "taskId
TaskId

Unique task identifier

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

": "{Integer}",
42
                         "type
Type

The type of the task

Possible domain values can be found here

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

": "{String}",
43
                         "title
Title

The title/summary of the task

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

": "{String}",
44
                         "createdAt
CreatedAt

Date and time of creation

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

": "{Datetime}",
45
                         "status
Status

The status of a task

Possible domain values can be found here

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

": "{Integer}",
46
                         "priority
Priority

The priority of the task.

Possible domain values can be found here

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

": "{Integer}",
47
                         "taskLink
TaskLink

Task reference

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

": "{String}"
48
                    }
49
               ],
50
               "productStructureMaterialLink
ProductStructureMaterialLink

Product structure material reference

": "{String}"
51
          }
52
     ],
53
     "paging
Paging

Detailed paging information for this list.

": {
54
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
66
     }
67
}

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 101606 HTTP 404 Module not found
Error 101746 HTTP 404 Product structure not found. Id: {0}
Error 105970 HTTP 400 End date is required