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

Plates - All plates are returned

URL Format

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

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="Plate">

<Key>

<PropertyRef Name="PlateId"/>

</Key>

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

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

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

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

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

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

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

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

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

"value": [

{

PlateId: 5001,

PlateNumber: "DST_PL01",

Xdim: 1,

Ydim: 1,

PlateOrigin: "C1024",

UnitId: 500132,

HeatId: 5061,

DpId: 5020,

ProjId: "RS"

},

{

PlateId: 5002,

PlateNumber: "DEFAULT PLATE 5002",

Xdim: 0,

Ydim: 0,

PlateOrigin: "MRR",

UnitId: 500140,

HeatId: 5081,

DpId: 5020,

ProjId: "RS"

}]

}

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