API

Product APIs

GET product/structure-versions/{productStructureVersionId}/materials/{productStructureMaterialId}

Product structure version's material details for provided identifier

HTTP method GET
URI https://api.rambase.net/product/structure-versions/{productStructureVersionId}/materials/{productStructureMaterialId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productStructureVersionId} Product structure identifier
Integer, minimum 100000
- URI parameter {productStructureMaterialId} Product structure material identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 3961, version 15

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
$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.
$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.

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

Product structure material identifier

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

Date and time of creation

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

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

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

Note for product structure version's material

>{String}</Note>
6
     <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>
7
     <WastagePercent
WastagePercent

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

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

A customer's reference number for product structure material

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

A product structure material's placement in the assembly

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

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
14
          <MeasurementUnit
MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

>
15
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

>{Integer}</MeasurementUnitId>
16
               <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

>{String}</Unit>
17
               <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
18
          </MeasurementUnit>
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=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=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=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=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=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=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=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=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=LatestTenPreProductionTasks in your request URI to get this field

>{String}</TaskLink>
47
          </Task>
48
     </LatestTenPreProductionTasks>
49
     <Procurement>
50
          <NumberOfPurchaseQuotes
NumberOfPurchaseQuotes

Number of purchase quotes

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

>{Integer}</NumberOfPurchaseQuotes>
51
          <NumberOfPurchaseQuoteRequests
NumberOfPurchaseQuoteRequests

Number of purchase quote requests

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

>{Integer}</NumberOfPurchaseQuoteRequests>
52
          <PurchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

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

>
53
               <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
54
               <FirstName
FirstName

First name of employee

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

>{String}</FirstName>
55
               <LastName
LastName

Last name of employee

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

>{String}</LastName>
56
               <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
57
          </PurchaseResponsible>
58
     </Procurement>
59
</ProductStructureMaterial>
1
{
2
     "productStructureMaterial": {
3
          "productStructureMaterialId
ProductStructureMaterialId

Product structure material identifier

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

Date and time of creation

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

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

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

Note for product structure version's material

": "{String}",
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}",
8
          "wastagePercent
WastagePercent

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

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

A customer's reference number for product structure material

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

A product structure material's placement in the assembly

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

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
15
               "measurementUnit
MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

": {
16
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

": "{Integer}",
17
                    "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

": "{String}",
18
                    "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{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=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=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=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=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=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=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=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=LatestTenPreProductionTasks in your request URI to get this field

": "{String}"
48
               }
49
          ],
50
          "procurement": {
51
               "numberOfPurchaseQuotes
NumberOfPurchaseQuotes

Number of purchase quotes

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

": "{Integer}",
52
               "numberOfPurchaseQuoteRequests
NumberOfPurchaseQuoteRequests

Number of purchase quote requests

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

": "{Integer}",
53
               "purchaseResponsible
PurchaseResponsible

User responsible for the procurement transaction

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

": {
54
                    "employeeId
EmployeeId

Employee identifier

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

": "{Integer}",
55
                    "firstName
FirstName

First name of employee

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

": "{String}",
56
                    "lastName
LastName

Last name of employee

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

": "{String}",
57
                    "employeeLink
EmployeeLink

Employee reference

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

": "{String}"
58
               }
59
          }
60
     }
61
}

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 105969 HTTP 400 Start date is required
Error 105970 HTTP 400 End date is required