This API retrieves the results of a Forecast Run.
Required Privilege: API_GET_FORECAST_RESULTS
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 1})/Com.Ingr.Smat.V1.ForecastResults(NlsId=value)/
Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment. Parameter key defines the Forecast header Id (FahId) and in the Forecast Results, the value indicates the NlsId.
|
Element |
Description |
Type |
Required |
|---|---|---|---|
|
FahId |
Unique ID of the Forecast header |
Integer |
Required |
|
NlsId |
Unique ID of the national language |
Integer |
Required |
Sample Code
GET https://{host}/Smat/V1/Projects('RS')/Disciplines('PIPING')/NLS('English')/Forecasts(10000027933)/Com.Ingr.Smat.V1.ForecastResults(NlsId=1)/
Success Response
Status: 200 OK
{
"@odata.context": "http://localhost:59387/SMAT/V1/$metadata#Collection(Com.Ingr.Smat.V1.ForecastResult)",
"value": [
{
"LnCode": "KVJOBAREA",
"BOMPath": "/KVJOBTEST/KVJOBUNIT/KVJOBAREA",
"LpId": 10000101699,
"ListPosition": "60",
"CommodityCode": "154102DXD1P4HNSN",
"CommodityCodeShortDesc": "Sev serv ctrl valve , Duplex , DN 25 , PN 150 , Without handwheel , Without solenoid ",
"TagNumber": " ",
"IdentCode": "C2KRJJ",
"Size1": "0",
"Size2": "0",
"Size3": "0",
"Size4": "0",
"Size5": "0",
"ShortCode": null,
"StatId": 10000010883,
"BOMQty": 100,
"UnitCode": "EA",
"TotalResvQty": null,
"ActualAllocatedQty": 30,
"ManualAllocatedQty": 0,
"OnHandQty": null,
"WhCode": null,
"LocCode": null,
"ROSDate": null,
"ETADate": null,
"PromOnSiteDate": null,
"AllocationType": "Requisition",
"AllocationDetailType": "3333333333"
}
]
}
|
Element |
Description |
Type |
|---|---|---|
|
IdentCode |
Unique code or name of the ident.
|
String |
|
LnCode |
Name of the list node |
String |
|
Size (1-5) |
Value of geometric details
|
String |
|
OnHandQty |
On-hand quantity of this inventory item in the displayed warehouse location |
Decimal |
|
CommodityCodeShortDesc |
Short description of the commodity code |
String |
|
ListPosition |
List position of the BOM for which the material is reserved |
String |
|
ETADate |
Expected time of arrival of the material. It refers to PredOnSite Date in Smart Materials |
Date Time Offset |
|
ROSDate |
Date and time when the material is required on site |
Date Time Offset |
|
CommodityCode |
Name of the commodity |
String |
|
LocCode |
Name of the location |
String |
|
TagNumber |
Tag number |
String |
|
AllocationType |
Defines the level where the material is allocated. Available values are:
|
String |
|
BOMPath |
BOM path of the list node |
String |
|
LpId |
Unique ID of the list position |
Decimal |
|
BOMQty |
Quantity of the list positions |
Decimal |
|
ShortCode |
Specifies the short code |
String |
|
StatId |
Unique ID of the issue status |
Decimal |
|
WhCode |
Name of the associated warehouse |
String |
|
TotalResvQty |
Total reserved quantity of a list position. |
Decimal |
|
UnitCode |
Name of the unit |
String |
|
ActualAllocatedQty |
Quantity that is forecasted by this job. This quantity is reserved for the given Reservation job.
|
Decimal |
|
PromOnsiteDate |
Promised on Site date |
Date Time Offset |
|
ManualAllocatedQty |
Manually reserved quantity of the items |
Decimal |
|
OnHandQty |
On-hand quantity of this inventory item in the displayed warehouse location |
Decimal |
|
AllocationDetailType |
Maximum five values are allowed.
ETADate, ROSDate, and PromOnSiteDate