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

ListPositions - All list positions are returned

URL Format

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

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="ListPosition">

<Key>

<PropertyRef Name="LpId"/>

</Key>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<Property Name="LockInd" 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}')/ListPositions",

"value": [

{

LpId: 5989735,

LnId: 293214,s

StatId: 5565,

ProjId: "CD",

LstId: 5021,

DpId: 5020,

LpPos: "10",

Quantity: 10,

RequisitionInd: "N",

LoadInd: "Y",

ParentLpId: null,

CommodityId: 4507598,

PartId: 500244,

UnitId: 500127,

Ident: 14640871,

ShortCode: null,

ItyId: 500018,

LpSubPos: null,

Input1: "10",

Input2: "2",

Input3: "S-20",

Input4: "S-STD",

Input5: "0",

ResvQty: 0,

TagNumber: null,

FahId: null,

GroupId: 500054,

IssueQty: 0,

Weight: null,

WeightUnitId: null,

PlateId: null,

LockInd: "N"

},

{

LpId: 5989736,

LnId: 293214,

StatId: 5565,

ProjId: "CD",

LstId: 5021,

DpId: 5020,

LpPos: "20",

Quantity: 10,

RequisitionInd: "Y",

LoadInd: "N",

ParentLpId: null,

CommodityId: 4507598,

PartId: 500244,

UnitId: 500127,

Ident: 14640673,

ShortCode: null,

ItyId: 500018,

LpSubPos: null,

Input1: "10",

Input2: "10",

Input3: "S-20",

Input4: "S-20",

Input5: "0",

ResvQty: 0,

TagNumber: null,

FahId: null,

GroupId: 500054,

IssueQty: 0,

Weight: null,

WeightUnitId: null,

PlateId: null,

LockInd: "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