This API starts an existing Forecast Run that does not perform any reservations and inventory remains same.
If you start the same Forecast Run 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 |
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.
Sample Code
POST https://{host}/Smat/V1/Projects('RS')/Disciplines('PIPING')/NLS('English')/Forecasts(5678)/Com.Ingr.Smat.V1.Start/
Success Response
Status: 200 OK
{
"@odata.context": "https://{host}/SMAT/V1/$metadata#Com.Ingr.Smat.Core.V1.ForecastRunResponse",
"ForecastStatus":"FORECASTED",
"Url": "https://{host}/Smat/V1/Projects('RS')/Disciplines('PIPING')/Nls('English’)/Forecasts(5678)/Com.Ingr.Smat.V1.ForecastResults(nlsId={NlsIDs})/"
}
Element |
Description |
Type |
Notes |
---|---|---|---|
ForecastStatus |
Status of the Forecast Run |
String |
|
Url |
URL to view the Forecast Results |
String |