Start Forecast Run asynchronously - 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 starts a Forecast Run asynchronously that does not perform any reservations and inventory remain same.

If you start the same Forecast Run asynchronously again, the results remain same.

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

Prefer

Indicates server behavior that is preferred by the client

Required

respond-async

Body

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

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

POST https://{host}/Smat/V1/Projects('RS')/Disciplines('PIPING')/NLS('English')/Forecasts(5236)/Com.Ingr.Smat.V1.Start/

Success Response

Status: 202 Accepted