InvPosReservations - 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

InvPosReservations - All inventory position reservations are returned

URL Format

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

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="InvPosReservation">

<Key>

<PropertyRef Name="IvprId"/>

</Key>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</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}')/InvPosReservations",

"value": [

{

IvprId: 5717,

ProjId: "RS",

LpId: 2873758,

IviId: 5107,

ItemShipId: null,

FahId: 5699,

DpId: 500017,

UnitId: 500127,

IvprType: "RR",

ResvQty: 0,

Ident: 44864086,

LnId: 196643,

TransResvQty: 0,

OldResvQty: 0,

ParentIvprId: null,

OriginalLpId: null,

OriginalResvQty: 0,

FsmnSelInd: "N"

},

{

IvprId: 5718,

ProjId: "RS",

LpId: 2873759,

IviId: 5108,

ItemShipId: null,

FahId: 5699,

DpId: 500017,

UnitId: 500127,

IvprType: "RR",

ResvQty: 0,

Ident: 44864087,

LnId: 196643,

TransResvQty: 0,

OldResvQty: 0,

ParentIvprId: null,

OriginalLpId: null,

OriginalResvQty: 0,

FsmnSelInd: "N"

}]

}

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