View an asynchronous Forecast job status - Intergraph Smart Materials - Version 2017 R1 (2.1) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R1 (2.1)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Version Smart Materials Web API
2017 R1 (2.1)

This API retrieves an asynchronous Forecast job status.

Required Privilege: API_RUN_FAHEADER

Headers

Header Name

Description

Required

Values

Authorization

Access Token

Required

Bearer<access_token>

Content-Type

Request type format

Required

application/JSON

Body

URL Format: GET https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/Forecasts({key})/Com.Ingr.Smat.V1.JobStatus/

Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the Forecast header Id (FahId).

Sample Code

GET https://{host}/Smat/V1/Projects('RS')/Disciplines('PIPING')/NLS('English')/Forecasts(789654)/Com.Ingr.Smat.V1.JobStatus/

Success Response

Status: 200 OK

{

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

"JobStatus":"SUCCEEDED",

"Url":"https://{host}/Smat/V1/Projects('RS')/Disciplines('PIPING')/Nls('English')/ Forecasts(789654)/ForecastResults (nlsId=1)"

}

Element

Description

Type

JobStatus

Status of the Forecast job

String

Url

URL to view the Forecast Results

String