Production APIs
Report that shows the detailed cost per produced unit for the complete structure, including all sub levels. The report requires a Goods Reception Id - this can either be specified when calling up the report by giving the NO as the first parameter of the filter, for example: REPORT/106967;100000 Or by giving it in the 'Goods reception id'-field in the report view.
| Report name | Goods reception structure and cost |
| Report identifier | 106967 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/106967/result-set?GoodsReceptionId={GoodsReceptionId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 200 |
| API resource identifier | 4668, version 9 |
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.
| GoodsReceptionId Integer, required |
Goods reception identifier
Minimum: 10000 |
| $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.
Code
WBS code for the element
>{String}</Code>GoodsReception
Goods reception reference
>GoodsReceptionId
Goods reception identifier
>{Integer}</GoodsReceptionId>GoodsReceptionItemId
Item-/line-number of the goods reception
>{Integer}</GoodsReceptionItemId>GoodsReceptionLink
Goods reception reference
>{String}</GoodsReceptionLink>StructureItemNumber
Automatic item counter for material/part lines in the KIT
>{Integer}</StructureItemNumber>ProductStructureMaterialId
Product structure material identifier
>{Integer}</ProductStructureMaterialId>OperationNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</OperationNumber>StructureItemClass
Operation class (PRODUCTION, TEST, ...) for operation lines,
product class (P, M, K ...) for material/part lines,
(PRODADDEDCOST, PARTCHANGE) for cost lines.
StructureItem
Operation id (OPR/nnnnnn) for operation line,
product id (ART/#nnnnnn) for material/part lines,
cost id (CST/nnnnnn) for added cost lines.
ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>StructureItemName
Product structure material's product name
Name of the operation for operation lines.
UsedQuantity
Quantity used on work order operation material
>{Decimal}</UsedQuantity>AccruedFixedCost
Accrued fixed cost
>{Decimal}</AccruedFixedCost>AccruedVariableCost
Accrued variable cost
>{Decimal}</AccruedVariableCost>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>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>Code
WBS code for the element
": "{String}",GoodsReception
Goods reception reference
": {GoodsReceptionId
Goods reception identifier
": "{Integer}",GoodsReceptionItemId
Item-/line-number of the goods reception
": "{Integer}",GoodsReceptionLink
Goods reception reference
": "{String}"StructureItemNumber
Automatic item counter for material/part lines in the KIT
": "{Integer}",ProductStructureMaterialId
Product structure material identifier
": "{Integer}",OperationNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",StructureItemClass
Operation class (PRODUCTION, TEST, ...) for operation lines,
product class (P, M, K ...) for material/part lines,
(PRODADDEDCOST, PARTCHANGE) for cost lines.
StructureItem
Operation id (OPR/nnnnnn) for operation line,
product id (ART/#nnnnnn) for material/part lines,
cost id (CST/nnnnnn) for added cost lines.
ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}"StructureItemName
Product structure material's product name
Name of the operation for operation lines.
UsedQuantity
Quantity used on work order operation material
": "{Decimal}",AccruedFixedCost
Accrued fixed cost
": "{Decimal}",AccruedVariableCost
Accrued variable cost
": "{Decimal}",TargetApplication
Application reference when inspecting a line in a report.
": "{String}"
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 104920 HTTP 400 | Log text is required |
| Error 104921 HTTP 400 | Invalid log category |
| Error 101281 HTTP 400 | Too many {0} parameters. Maximum is {1}. |
| Error 100175 HTTP 400 | To date must be equal to, or later than from date. |
| Error 105710 HTTP 400 | Invalid output type |