Forecast Results - 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

Forecast Results - Here you can see the results of the forecast run.

URL Format

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

Specify values for project, discipline, language and key parameters in the URL. The first three values together define the project environment of the forecast run. The key parameter defines the forecast header id, which is posted.

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

Method

GET

Required Privilege

API_GET_FORECAST_RESULTS

Data Parameter

None

Success Response

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

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

<Parameter Name="bindingParameter"

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

<Parameter Name="nlsId" Type="Edm.Int64" Nullable="false"/>

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

</Function>

JSON results are will be as defined below:

<ComplexType Name="FahResult">

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

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

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

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

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

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

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

<Property Name="OnHandQty" Type="Edm.Decimal"/>

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

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

<Property Name="EtaDate" Type="Edm.DateTimeOffset"/>

<Property Name="ReqSiteDate" Type="Edm.DateTimeOffset"/>

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

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

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

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

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

<Property Name="LpId" Type="Edm.Decimal"/>

<Property Name="LpQty" Type="Edm.Decimal"/>

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

<Property Name="ResvQty" Type="Edm.Decimal"/>

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

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

</ComplexType>


Code: 200 OK

Content:

{

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

"FahId": 13822,

"NlsId": 5,

"Results": [

{

"IdentCode": "CCB8J8",

"LnCode": "01",

"Input1": "10",

"Input2": "10",

"Input3": "S-20",

"Input4": "S-20",

"Input5": "0",

"OnHandQty": 0,

"CcShortDesc": null,

"LpPos": "20",

"EtaDate": null,

"ReqSiteDate": null,

"CommodityCode": "DRW1A5VZM10000",

"LocCode": "LOC-A",

"TagNumber": " ",

"IisDetailType": "CCB8J8",

"BomPath": "/Piping/A/01",

"LpId": 6264018,

"LpQty": 30,

"WhCode": "WH-001",

"ResvQty": 0,

"UnitCode": "EA",

"IisType": "IVI"

}

}

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