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

Warehouses - All warehouses are returned

URL Format

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

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="Warehouse">

<Key>

<PropertyRef Name="WhId"/>

</Key>

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

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

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

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

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

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

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

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

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

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

"value": [

{

"WHID": 5040,

"PROJID": "RS",

"WHCODE": "WH-01",

"MULTIWHIND": "Y",

"DECHISWHIND": "N",

"SCRAPWHIND": "N",

"NESTEDPLATEIND": "N",

"CORPORATEWHIND": "N",

"FREEMATERIALWHIND": "N",

"RENTALIND": "N"

},

{

"WHID": 5041,

"PROJID": "RS",

"WHCODE": "WH-02",

"MULTIWHIND": "N",

"DECHISWHIND": "Y",

"SCRAPWHIND": "N",

"NESTEDPLATEIND": "N",

"CORPORATEWHIND": "N",

"FREEMATERIALWHIND": "N",

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