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

Disciplines - All disciplines of a project are returned

URL Format

https://{host}/Smat/V1/Projects(':project')/Disciplines

Specify values for ProjId parameter in the URL.

Use the following read-only APIs to get the available values for each parameter.

/Projects

URL Parameter

:project

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="Discipline">

<Key>

<PropertyRef Name="DisciplineCode"/>

</Key>

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

<Property Name="DisciplineCode" Type="Edm.String" Nullable="false"/>

<NavigationProperty Name="Nls" Type="Collection(Com.Ingr.SpMat.Core.V1.Nls)"ContainsTarget="true"/>

</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",

"value": [

{

DisciplineId: "5020",

DisciplineCode: "PIPING"

},

{

DisciplineId: "500013",

DisciplineCode: "MECHANICAL"

},

{

DisciplineId: "500015",

DisciplineCode: "INSTRUMENT"

}

]

}

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