Asynchronous Forecast Job Status - 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

Asynchronous Forecast Job Status -

URL Format

/Projects(':project')/Disciplines(':discipline')/Nls(':language')/ ForecastHeaders (‘:key’)/Com.Ingr.Smat.V1.JobStatus/

Specify values for project, discipline, language and key parameters in the URL. The first three values together define a project environment in which the forecast header is created. The key parameter defines the forecast header id, for which the status is fetched.

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

/Projects,

/projects(':project')/Disciplines,

/projects(':project')/Disciplines(':discipline')/nls

URL Parameter

:project, :discipline, :language, :key

Data Parameter

None

Method

GET

Required Privilege

API_RUN_FAHEADER

Success Response

HTTP status code sent back to client on the API execution success:

<Function Name="JobStatus" IsBound="true">

<Parameter Name="bindingParameter" 

Type="Com.Ingr.Smat.Core.V1.Forecast"/>

<ReturnType Type="Com.Ingr.Smat.Core.V1.JobResult"/>

</Function>

This function returns JobResult in JSON format structure as defined below:

<ComplexType Name="JobResult">

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

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

</ComplexType>

Where:

JobStatus (Edm.String):

Url (Edm.String):

Code: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Com.Ingr.Smat.V1.JobResult",

"JobStatus": "SUCCEEDED",

"Url": "https://{host}/Smat/V1/Projects('{project}')/Disciplines('{discipline}')/Nls('{nls}')/ forecastheaders ({fahid})/ForecastResults (nlsId=1)"

}

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