InvItems - Intergraph Smart Materials - Version 2017 (2.0) - Help - Hexagon PPM

Intergraph Smart Materials Web API Help 2017 (2.0)

PPMProduct
Intergraph Smart Materials
PPMCategory_custom
Help

Name and Description

InvItems - All inventory items are returned

URL Format

https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/InvItems

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="InvItem">

<Key>

<PropertyRef Name="IviId"/>

</Key>

<Property Name="IviId" Type="Edm.Int64" Nullable="false"/>

<Property Name="ProjId" Type="Edm.String"/>

<Property Name="Ident" Type="Edm.Int64"/>

<Property Name="WhId" Type="Edm.Int64"/>

<Property Name="LocId" Type="Edm.Int64"/>

<Property Name="SmstId" Type="Edm.Int64"/>

<Property Name="UnitId" Type="Edm.Int64"/>

<Property Name="DpId" Type="Edm.Int64"/>

<Property Name="RecvQty" Type="Edm.Decimal"/>

<Property Name="ResvQty" Type="Edm.Decimal"/>

<Property Name="IssueQty" Type="Edm.Decimal"/>

<Property Name="ItyId" Type="Edm.Int64"/>

<Property Name="TagNumber" Type="Edm.String"/>

<Property Name="SasId" Type="Edm.Int64"/>

<Property Name="HeatId" Type="Edm.Int64"/>

<Property Name="IdentDeviation" Type="Edm.String"/>

<Property Name="PlateId" Type="Edm.Int64"/>

<Property Name="IntResvQty" Type="Edm.Decimal"/>

<Property Name="ManResvQty" Type="Edm.Decimal"/>

<Property Name="TransRecvQty" Type="Edm.Decimal"/>

<Property Name="PicsRecvQty" Type="Edm.Decimal"/>

<Property Name="OiRecvQty" Type="Edm.Decimal"/>

<Property Name="DciRecvQty" Type="Edm.Decimal"/>

<Property Name="SubstTransRecvQty" Type="Edm.Decimal"/>

<Property Name="RtiRetQty" Type="Edm.Decimal"/>

<Property Name="OnhandQty" Type="Edm.Decimal"/>

</EntityType>

HTTP status code sent back to client on the API execution success: 
Code: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('{project}')/Disciplines('{discipline}')/Nls('{nls}')/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

},

{

IviId: 5061,

ProjId: "RS",

Ident: 7500826,

WhId: 5040,

LocId: 5040,

SmstId: 5040,

UnitId: 500127,

DpId: 500017,

RecvQty: 1,

ResvQty: 0,

IssueQty: 1,

ItyId: 500019,

TagNumber: "5-DA-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

}]

}

Error Response

This API may fail with the following error messages: 
Error Code: 401 Unauthorized 
Content:

{

"error": {

"code": "",

"message": "Authorization has been denied for this request." }

}

Notes