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

Companies - All companies are returned

URL Format

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

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="Company">

<Key>

<PropertyRef Name="CompanyId"/>

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

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

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

"value": [

{

"CompanyId": 5265,

"CompanyCode": "UMM OBDGOVOX",

"CompanyName": "UMM OBDGOVOX"

},

{

"CompanyId": 5341,

"CompanyCode": "UWJ",

"CompanyName": "UWJ Begdl Uzogaxu Abx"

}]

}

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