API

Product APIs

GET production/work-order-operations/{workOrderOperationId}/structure-materials/{productStructureMaterialId}/applicable-goods-reception-items

Get list of all applicable goods reception items for work order operation's structure material

HTTP method GET
URI https://api.rambase.net/production/work-order-operations/{workOrderOperationId}/structure-materials/{productStructureMaterialId}/applicable-goods-reception-items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {workOrderOperationId} Production work order operation identifier
Integer, minimum 100000
- URI parameter {productStructureMaterialId} Product structure item identifier
Integer, minimum 1
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 7283, version 4

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.

AvailableQuantity Decimal Quantity available/free for use. Not assigned to anything.
Database String Company code/database the object belongs to.
GoodsReceptionId Integer Goods reception identifier.
GoodsReceptionItemId Integer Item-/line-number of the goods reception.
HeatNumber String A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
IsBlockedForPicking Boolean True if picking from this stock location is not allowed.
LocationId Integer Location identifier.
MaterialQualityInternalNote String Additonal quality codes that are covered in addition to the code given by the field Quality description.
ProductDescription String Description of the product.
ProductId Integer Assignment register identifier.
ProductionLot String The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
ProductName String Name of the product.
QualityCode String Quality of the material. Only used for information.
Quantity Decimal Initial quantity placed in the stock location.
RemainingQuantity Decimal Quantity from goods reception item remaining in stock location.
SerialNumber String Serial number.
Status Integer Status of stock location assignment.
StockAssignmentId Integer Assignment register identifier.
StockLocationAssignmentId Integer Stock location assignment identifier.
StockLocationId Integer Stock location identifier.
StockLocationLabel String Name of current- and parent stock locations, including seperator for location.

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

AvailableQuantity Decimal Quantity available/free for use. Not assigned to anything.
Database String Company code/database the object belongs to
GoodsReceptionId Integer Goods reception identifier
GoodsReceptionItemId Integer Item-/line-number of the goods reception
HeatNumber String A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.
IsBlockedForPicking Boolean True if picking from this stock location is not allowed
LocationId Integer Location identifier
MaterialQualityInternalNote String Additonal quality codes that are covered in addition to the code given by the field Quality description
ProductDescription String Description of the product
ProductId Integer Assignment register identifier
ProductionLot String The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.
ProductName String Name of the product
QualityCode String Quality of the material. Only used for information.
Quantity Decimal Initial quantity placed in the stock location
RemainingQuantity Decimal Quantity from goods reception item remaining in stock location
SerialNumber String Serial number
Status Integer Status of stock location assignment
StockAssignmentId Integer Assignment register identifier
StockLocationAssignmentId Integer Stock location assignment identifier
StockLocationId Integer Stock location identifier
StockLocationLabel String Name of current- and parent stock locations, including seperator for location

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
<ApplicableGoodsReceptionItems>
2
     <ApplicableGoodsReceptionItem>
3
          <IsAssignedToOperation
IsAssignedToOperation

A flag to indicate if goods reception item is assigned to production work order which this work order operation belongs to

>{Boolean}</IsAssignedToOperation>
4
          <StockLocationAssignment>
5
               <StockLocationAssignmentId
StockLocationAssignmentId

Stock location assignment identifier

>{Integer}</StockLocationAssignmentId>
6
               <Status
Status

Status of stock location assignment

Possible domain values can be found here

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

Initial quantity placed in the stock location

>{Decimal}</Quantity>
8
               <RemainingQuantity
RemainingQuantity

Quantity from goods reception item remaining in stock location

>{Decimal}</RemainingQuantity>
9
               <IsBlockedForPicking
IsBlockedForPicking

True if picking from this stock location is not allowed

>{Boolean}</IsBlockedForPicking>
10
               <GoodsReceptionItem>
11
                    <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
12
                    <AvailableQuantity
AvailableQuantity

Quantity available/free for use. Not assigned to anything.

>{Decimal}</AvailableQuantity>
13
                    <Database
Database

Company code/database the object belongs to

>{String}</Database>
14
                    <HeatNumber
HeatNumber

A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.

>{String}</HeatNumber>
15
                    <ProductionLot
ProductionLot

The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.

>{String}</ProductionLot>
16
                    <MaterialQuality>
17
                         <QualityCode
QualityCode

Quality of the material. Only used for information.

>{String}</QualityCode>
18
                         <InternalNote
InternalNote

Additonal quality codes that are covered in addition to the code given by the field Quality description

>{String}</InternalNote>
19
                    </MaterialQuality>
20
                    <GoodsReception>
21
                         <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
22
                         <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
23
                         <GoodsReceptionLink
GoodsReceptionLink

Goods reception identifier

>{String}</GoodsReceptionLink>
24
                    </GoodsReception>
25
                    <Product>
26
                         <ProductId
ProductId

Assignment register identifier

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

Name of the product

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

Description of the product

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

Product reference

>{String}</ProductLink>
30
                    </Product>
31
                    <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
32
               </GoodsReceptionItem>
33
               <StockLocation>
34
                    <StockLocationId
StockLocationId

Stock location identifier

>{Integer}</StockLocationId>
35
                    <Name
Name

Name of stock location

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

>{String}</Name>
36
                    <Label
Label

Name of current- and parent stock locations, including seperator for location

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

>{String}</Label>
37
                    <IsBlockedForStock
IsBlockedForStock

Determines whether or not this stock location is blocked for stock

>{Boolean}</IsBlockedForStock>
38
                    <Location>
39
                         <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
40
                         <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
41
                    </Location>
42
                    <StockLocationLink
StockLocationLink

Stock location reference

>{String}</StockLocationLink>
43
               </StockLocation>
44
               <StockLocationAssignmentLink
StockLocationAssignmentLink

Reference to stock location assignment

>{String}</StockLocationAssignmentLink>
45
          </StockLocationAssignment>
46
     </ApplicableGoodsReceptionItem>
47
     <Paging
Paging

Detailed paging information for this list.

>
48
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
51
          <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>
52
          <FirstPage
FirstPage

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

>{String}</FirstPage>
53
          <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>
54
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
55
          <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>
56
          <NextPage
NextPage

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

>{String}</NextPage>
57
          <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>
58
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
60
     </Paging>
61
</ApplicableGoodsReceptionItems>
1
{
2
     "applicableGoodsReceptionItems": [
3
          {
4
               "isAssignedToOperation
IsAssignedToOperation

A flag to indicate if goods reception item is assigned to production work order which this work order operation belongs to

": "{Boolean}",
5
               "stockLocationAssignment": {
6
                    "stockLocationAssignmentId
StockLocationAssignmentId

Stock location assignment identifier

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

Status of stock location assignment

Possible domain values can be found here

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

Initial quantity placed in the stock location

": "{Decimal}",
9
                    "remainingQuantity
RemainingQuantity

Quantity from goods reception item remaining in stock location

": "{Decimal}",
10
                    "isBlockedForPicking
IsBlockedForPicking

True if picking from this stock location is not allowed

": "{Boolean}",
11
                    "goodsReceptionItem": {
12
                         "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
13
                         "availableQuantity
AvailableQuantity

Quantity available/free for use. Not assigned to anything.

": "{Decimal}",
14
                         "database
Database

Company code/database the object belongs to

": "{String}",
15
                         "heatNumber
HeatNumber

A heat number is an identification coupon number that is stamped on a material plate after it is removed from the ladle and rolled at a steel mill.

": "{String}",
16
                         "productionLot
ProductionLot

The production lot refers to the particular production unit of the manufactured item. Identification assigned to a particular quantity/lot/batch.

": "{String}",
17
                         "materialQuality": {
18
                              "qualityCode
QualityCode

Quality of the material. Only used for information.

": "{String}",
19
                              "internalNote
InternalNote

Additonal quality codes that are covered in addition to the code given by the field Quality description

": "{String}"
20
                         },
21
                         "goodsReception": {
22
                              "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
23
                              "registrationDate
RegistrationDate

Date of registration

": "{Date}",
24
                              "goodsReceptionLink
GoodsReceptionLink

Goods reception identifier

": "{String}"
25
                         },
26
                         "product": {
27
                              "productId
ProductId

Assignment register identifier

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

Name of the product

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

Description of the product

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

Product reference

": "{String}"
31
                         },
32
                         "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
33
                    },
34
                    "stockLocation": {
35
                         "stockLocationId
StockLocationId

Stock location identifier

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

Name of stock location

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

": "{String}",
37
                         "label
Label

Name of current- and parent stock locations, including seperator for location

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

": "{String}",
38
                         "isBlockedForStock
IsBlockedForStock

Determines whether or not this stock location is blocked for stock

": "{Boolean}",
39
                         "location": {
40
                              "locationId
LocationId

Location identifier

": "{Integer}",
41
                              "locationLink
LocationLink

Location reference

": "{String}"
42
                         },
43
                         "stockLocationLink
StockLocationLink

Stock location reference

": "{String}"
44
                    },
45
                    "stockLocationAssignmentLink
StockLocationAssignmentLink

Reference to stock location assignment

": "{String}"
46
               }
47
          }
48
     ],
49
     "paging
Paging

Detailed paging information for this list.

": {
50
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
62
     }
63
}

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: