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

FAHeaders - All forecast headers are returned

URL Format

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

URL Parameter

:project, :discipline, :language

Data Parameter

None

Method

GET

Required Privilege

API_READONLY

Success Response

Response Metadata:

<EntityType Name="FaHeader">

<Key>

<PropertyRef Name="FahId"/>

</Key>

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

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

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

<Property Name="RunNumber" Type="Edm.Int16"/>

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

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

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

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

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

</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}')/FaHeaders",

"value": [

{

FahId: 13782,

ProjId: "CD",

FahCode: "00000RW01",

RunNumber: 1,

FahType: "RR",

JobStatus: "REJECTED",

JobStartDate: "2009-12-14T09:39:06+05:30",

JobEndDate: "2009-12-14T09:39:13+05:30",

ParentFahId: null

},

{

FahId: 13822,

ProjId: "CD",

FahCode: "00000RW01",

RunNumber: 2,

FahType: "RR",

JobStatus: "ISSUED",

JobStartDate: "2009-12-19T16:37:06+05:30",

JobEndDate: "2009-12-19T16:37:11+05:30",

ParentFahId: 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