This API retrieves the inventory items of a project from Smart Materials. You can either retrieve a single inventory item using inventory item Id or all the inventory items of a project.
Required Privilege: API_READONLY
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format: GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/InvItem({key})
Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the inventory item Id (IviId).
To retrieve all the inventory items of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/InvItems
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/InvItems(5060)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/InvItems",
"value": [
{
"IviId":5060,
"ProjId":"RS",
"Ident":7500825,
"WhId":5040,
"LocId":5040,
"SmstId":5040,
"UnitId":500127,
"DpId":500017,
"RecvQty":1,
"ResvQty":0,
"IssueQty":1,
"ItyId":500019,
"TagNumber":"5-UB-3810",
"SasId":5000,
"HeatId":null,
"IdentDeviation":null,
"PlateId":null,
"IntResvQty":0,
"ManResvQty":0,
"TransRecvQty":0,
"PicsRecvQty":0,
"OiRecvQty":0,
"DciRecvQty":0,
"SubstTransRecvQty":0,
"RtiRetQty":0,
"OnhandQty":0
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
IviId |
Unique ID of the retrieved inventory item |
Integer |
|
ProjId |
Unique ID of the Project. Retrieved inventory item belongs to this Project. |
String |
|
Ident |
Ident number |
Integer |
|
WhId |
Unique ID of the warehouse |
Integer |
|
LocId |
Unique ID of the location where the ident is stored |
Integer |
|
SmstId |
Unique ID of the site material status |
Integer |
|
UnitId |
Unique ID of the units |
Integer |
|
DpId |
Unique ID of the Discipline. Retrieved inventory items belong to this Discipline. |
Integer |
|
RecvQty |
Received quantity |
Decimal |
|
ResvQty |
Quantity reserved by the Forecast |
Decimal |
|
IssueQty |
Issued quantity for the retrieved inventory items |
Decimal |
|
ItyId |
Unique ID of the inventory |
Integer |
|
TagNumber |
Tag number |
String |
|
SasId |
Unique ID of the site attribute sets |
Integer |
|
HeatId |
Unique ID of the heat number |
Integer |
|
IdentDeviation |
Ident deviation for the selected item |
String |
|
PlateId |
Unique ID of the plate |
Integer |
|
IntResvQty |
Actual or initial reserved quantity of the list position |
Decimal |
|
ManResvQty |
Manual reserved quantity against the inventory |
Decimal |
|
TransRecvQty |
Received quantity by a material transfer |
Decimal |
|
PicsRecvQty |
Received quantity by a physical count sheet rule |
Decimal |
|
OiRecvQty |
Received quantity by an overissue |
Decimal |
|
DciRecvQty |
Received quantity by a design change |
Decimal |
|
SubstTransRecvQty |
Received quantity by a substitution or transformation |
Decimal |
|
RiteReQty |
Return quantity for this inventory item from return to inventory number |
Decimal |
|
OnhandQty |
On hand quantity of the retrieved inventory items |
Decimal |