Start Forecast Run - 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

Start Forecast Run - This API is used for defining and starting a forecast run. A forecast run does not perform reservations. After running, the inventory will not be changed. If the same forecast run will be started once again this will have the same result.

URL Format

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

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 an inventory item is being added.

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

POST

Required Privilege

API_RUN_FAHEADER

Success Response

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

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

<ComplexType Name="ForecastRunResponse">

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

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

</ComplexType>

Code: 200 OK

Content:

{

"@odata.context": "http://{host}/SMAT/V1/$metadata#Com.Ingr.Smat.Core.V1.ForecastRunResponse",

"ForecastStatus": "FORECASTED",

"Url": "http://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language’)/ForecastHeaders(fahid)/Com.Ingr.Smat.V1.ForecastResults(nlsId={NlsIDs})/"

}

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