Business Assist API - ForecastDownload

API reference for the ForecastDownload API.

GET https://businessassist.microsoft.com/api/beta/forecast/{operationId}/download

GET https://eu.businessassist.microsoft.com/api/beta/forecast/{operationId}/download

URI Parameters

Name	In	Required	Type	Description
operationId	path	True	string	Unique job Id for the forecast job.

Responses

Name	Type	Description
202		The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place.
400		Input Data is null
403		Missing or incorrect permissions
500		Submit request failed

Examples

ForecastDownload (European endpoint)

ForecastDownload (global endpoint)

ForecastDownload (European endpoint)

Sample request

GET https://eu.businessassist.microsoft.com/api/beta/forecast/{operationId}/download

Sample response

Status code:

202

{
  "predictions": [
    {
    "date": "DateTime Offset",
    "forecast": "double",
    "low": "double",
    "high": "double"
    }
  ]
}

ForecastDownload (global endpoint)

Sample request

GET https://businessassist.microsoft.com/api/beta/forecast/{operationId}/download

Sample response

Status code:

202

{
  "predictions": [
    {
    "date": "DateTime Offset",
    "forecast": "double",
    "low": "double",
    "high": "double"
    }
  ]
}

Definitions

Name	Description
date	The date the forecast job was created.
forecast	Forecast for the defined time period.
high	High end of the forecast range predicted.
low	Low end of the forecast range predicted.

date

The date the forecast job was created.

forecast

Forecast for the defined time period.

high

High end of the forecast range predicted.

low

Low end of the forecast range predicted.