Business Assist API - ForecastStatus

API reference for the ForecastStatus API

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

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

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

ForecastStatus (European endpoint)

ForecastStatus (global endpoint)

ForecastStatus (European endpoint)

Sample request

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

Sample response

Status code:

202

{
  "operationId": "String",
  "name": "String",
  "status": "integer",
  "diagnostics": "string"
}

ForecastStatus (global endpoint)

Sample request

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

Sample response

Status code:

202

{
  "operationId": "String",
  "name": "String",
  "status": "integer",
  "diagnostics": "string"
}

Definitions

Name	Description
diagnostics	Errors or warnings generated during job creation
Job status codes	Code Job Status 0 Not started 1 In progress 2 Completed
name	Job name provided
operationId	Job ID
status	Code showing status of forecast job

diagnostics

Errors or warnings generated during job creation

Job status codes

Code	Job Status
0	Not started
1	In progress
2	Completed

name

Job name provided

operationId

Job ID

status

Code showing status of forecast job