Production APIs
Lists down picked materials for production work order
| HTTP method | GET |
| URI | https://api.rambase.net/production/work-orders/{productionWorkOrderId}/picked-materials |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productionWorkOrderId} |
Production work order identifier
Integer, minimum 100000 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6638, version 27 |
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.
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.
| OnlyTraceable() Named filter | Show only picks for traceable materials |
| PickedQuantity Decimal | Quantity picked. |
| ProducedSerialNumber String | Serial number. |
| ProductId Docref-it | Product identifier. |
| ProductName String | Name of the product. |
| ProductUnitId Integer | Product unit identifier. |
| SequenceNumber Integer | Sequence number of the product structure operation. Unique within a product structure. |
| TraceableMaterialQuantity Decimal | Quantity of product unit's traceable material. |
| TraceableMaterialSerialNumber String | Serial number. |
Read more about filters and sorting on how to use sortable parameters
| PickedQuantity Decimal | Quantity picked |
| ProducedSerialNumber String | Serial number |
| ProductId Docref-it | Product identifier |
| ProductName String | Name of the product |
| ProductUnitId Integer | Product unit identifier |
| SequenceNumber Integer | Sequence number of the product structure operation. Unique within a product structure. |
| TraceableMaterialQuantity Decimal | Quantity of product unit's traceable material |
| TraceableMaterialSerialNumber String | Serial number |
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.
PickStatus
Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.
Possible domain values can be found here
>{Integer}</PickStatus>PickedQuantity
Quantity picked
>{Decimal}</PickedQuantity>WorkOrderOperationId
Production work order operation identifier
>{Integer}</WorkOrderOperationId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>WorkOrderOperationLink
Work order operation reference
>{String}</WorkOrderOperationLink>ProductStructureMaterialId
Product structure material identifier
>{Integer}</ProductStructureMaterialId>Quantity
Quantity assigned
>{Decimal}</Quantity>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>ProductStructureVersionId
Product structure identifier
>{Integer}</ProductStructureVersionId>ProductStructureMaterialLink
Product structure material reference
>{String}</ProductStructureMaterialLink>ProductUnitId
Product unit identifier
>{Integer}</ProductUnitId>SerialNumber
Serial number
>{String}</SerialNumber>Quantity
Traceable material quantity
>{Decimal}</Quantity>SerialNumber
Serial number
>{String}</SerialNumber>GoodsReceptionItemId
Item-/line-number of the goods reception
>{Integer}</GoodsReceptionItemId>GoodsReceptionId
Goods reception identifier
>{Integer}</GoodsReceptionId>GoodsReceptionLink
Goods reception reference
>{String}</GoodsReceptionLink>GoodsReceptionItemLink
Goods reception item reference
>{String}</GoodsReceptionItemLink>PickId
Pick identifier for the pick operation
>{Integer}</PickId>PickedQuantity
Quantity picked
>{Decimal}</PickedQuantity>PickOperationId
Pick operation identifier
>{Integer}</PickOperationId>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>PickStatus
Status of the picking from this assignment. Note that the pick status of the assignment might differ from the status of the pick operation of the assigned item.
Possible domain values can be found here
": "{Integer}",PickedQuantity
Quantity picked
": "{Decimal}",WorkOrderOperationId
Production work order operation identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductionOperationLink
Production operation reference
": "{String}"WorkOrderOperationLink
Work order operation reference
": "{String}"ProductStructureMaterialId
Product structure material identifier
": "{Integer}",Quantity
Quantity assigned
": "{Decimal}",ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"ProductStructureVersionId
Product structure identifier
": "{Integer}"ProductStructureMaterialLink
Product structure material reference
": "{String}"ProductUnitId
Product unit identifier
": "{Integer}",SerialNumber
Serial number
": "{String}"Quantity
Traceable material quantity
": "{Decimal}",SerialNumber
Serial number
": "{String}"GoodsReceptionItemId
Item-/line-number of the goods reception
": "{Integer}",GoodsReceptionId
Goods reception identifier
": "{Integer}",GoodsReceptionLink
Goods reception reference
": "{String}"GoodsReceptionItemLink
Goods reception item reference
": "{String}"PickId
Pick identifier for the pick operation
": "{Integer}",PickedQuantity
Quantity picked
": "{Decimal}",PickOperationId
Pick operation identifier
": "{Integer}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 100199 HTTP 404 | Location is not found |
| Error 100089 HTTP 404 | Product {0} not found |