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

Listnodes - All list nodes are returned

URL Format

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

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="ListNode">

<Key>

<PropertyRef Name="LnId"/>

</Key>

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

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

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

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

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

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

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

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

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

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

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

</EntityType>

Following HTTP status code is sent back to client on the Success of the API execution: 
Code: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('{project}')/Disciplines('{discipline}')/Nls('{nls}')/Listnodes",

"value": [

{

LnId: 293213,

LsId: 5299,

ProjId: "CD",

DpId: 5020,

LnCode: "PIPING",

ParentLnId: null,

GeneratedName: null,

LoadInd: "Y",

LockInd: "N",

SiteStatId: null,

EstShortNodeInd: "N"

},

{

LnId: 293214,

LsId: 5299,

ProjId: "CD",

DpId: 5020,

LnCode: "01",

ParentLnId: 293213,

GeneratedName: null,

LoadInd: "Y",

LockInd: "N",

SiteStatId: 6685,

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