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

Projects - All projects are returned

URL Format

https://{host}/Smat/V1/Projects

URL Parameter

None

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="Project">

<Key>

<PropertyRef Name="ProjId"/>

</Key>

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

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

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

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

<Property Name="StartDate" Type="Edm.DateTimeOffset"/>

<Property Name="EndDate" Type="Edm.DateTimeOffset"/>

NavigationProperty Name="Disciplines" Type="Collection(Com.Ingr.SpMat.Core.V1.Discipline)" 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",

"value": [

{

"ProjId": "DOCU",

"Description": "NEW PROJECT",

"PgCode": "PG",

"PgrId": 5122,

"StartDate": null,

"EndDate": null

},

{

"ProjId": "TEST_LOGIN",

"Description": "NEW PROJECT",

"PgCode": "PG",

"PgrId": 5002,

"StartDate": null,

"EndDate": null

}

}

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