This API retrieves the total quantities of all the idents that belong to the given commodity code within the individual modules, in a project of Smart Materials.
Required Privilege: API_ITEM_DETAILS
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
HTTP Method: POST
URL Format:
https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/Commodities({key})/CommodityTotals
Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language, together define the project environment. The key parameter defines the commodity ID.
Sample Code
POST https://localhost:59387/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/Commodities(10000243189)/CommodityTotals
{
"ItemDetailsInput":
{
"InterestedTotals": ["BOM", "Req", "Inquiry","Order","Traffic","MLDIssue","ProvisionalReserved","OnHand"]
}
}
-
In the request body, you can specify the module names to "InterestedTotals" which you are looking for. Only these interested total quantities are retrieved and others are displayed as null. Valid inputs for InterestedTotals are BOM, Req, Inquiry, Order, Shipped, Traffic, Received, StockReceipt, BOMIssue, DirectIssue, MLDIssue, Reserved, ProvisionalReserved, OpenOSDs, and OnHand.
-
If you don't select any InterestedTotal, then the API retrieves all the total quantities.
-
If there is no quantity associated with a total , then the value is displayed as 0.
Success Response
Status:200OK
{
"@odata.context": "https://localhost:59387/SMAT/V1/$metadata#Collection(Com.Ingr.Smat.Core.V1.ItemTotalsInfo)",
"value": [
{
"Ident": 10000504671,
"UnitId": 500127,
"BOMTotal": 300,
"ReqTotal": 100,
"InquiryTotal": 10,
"OrderTotal": 60,
"ShippedTotal": null,
"TrafficActivityTotal": 10,
"ReceivedTotal": null,
"StockReceiptTotal": null,
"BOMIssueTotal": null,
"DirectIssueTotal": null,
"MLDIssueTotal": 0,
"ReservedTotal": null,
"ProvisionalReservedTotal": 19,
"NumberOfOpenOSDs": null,
"OnHandTotal": 10
}
]
}
|
Element |
Description |
Type |
|---|---|---|
|
Ident |
Unique ID of the ident |
Integer |
|
BOMTotal |
Total sum of quantity of this ident on BOM |
Integer |
|
ReqTotal |
Total sum of quantities of this ident on all the requisition line items
|
Integer |
|
InquiryTotal |
Total sum of quantity of this ident on inquiries. |
Integer |
|
OrderTotal |
Total sum of quantity of this ident on approved Purchase Orders |
Integer |
|
ShippedTotal |
Total sum of quantity of this ident on item shipments |
Integer |
|
TrafficActivityTotal |
Total sum of quantity of this ident on Traffic |
Integer |
|
ReceivedTotal |
Total sum of received quantities of this ident.
|
Integer |
|
StockReceiptTotal |
Total sum of stock receipt for this ident. |
Integer |
|
BOMIssueTotal |
Total sum of BOM issue for this ident.
|
Integer |
|
DirectIssueTotal |
Total sum of direct issue for this ident.
|
Integer |
|
MLDIssueTotal |
Total sum of quantity of this ident issued with a |
Integer |
|
ReservedTotal |
Total sum of quantity of this ident already reserved on the BOM.
|
Integer |
|
ProvisionalReservedTotal |
Total sum of the provisional reserved quantity for this ident. It cover all the reservations done manually. It includes the quantities that are entered in any MIR screen (apart from C.20.21
MIR by Reservation) For example, if the reservation run has reserved a quantity of 10 |
Integer |
|
NumberOfOpenOSDs |
Represents the number of over, short, and damaged reports (OS&Ds) for the selected ident |
Integer |
|
OnhandTotal |
Inventory On Hand Quantity (Recv Qty - Resv Qty - Issue Qty) |
Integer |
|
UnitId |
Refers to the quantity unit ID. The quantities will be converted to this unit shown based on the conversion factor defined in A.10.13 Unit to Unit. |
Integer |
Requisitions that are used for purchase (Purchase indicator is checked)