Forecast

Returns forecast summary information

This call returns a paginated list of forecast summary information for the specified job, date range or finalized since date.

Securitybearer
Request
query Parameters
jobId
string <uuid>

The job guid. If omitted, returns forecasts across all jobs.

startDate
string <date-time>

The start date in yyyy-MM-dd format. If omitted, returns forecasts from the beginning of time. (bounded by the end date).

endDate
string <date-time>

The end date in yyyy-MM-dd format. If omitted, returns forecasts until the end of time. (bounded by the start date).

finalizedSince
string <date-time>

The forecast finalized datetime in utc format (e.g., 2018-06-26T08:25:48Z). If omitted, returns all forecasts between start and end date.

limit
integer <int32>
Default: 1000

The maximum number of results that should be returned.

cursor
string

Optional. When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.

Responses
get/api/v1/forecastInfo
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Returns forecast details
This call returns forecast details for the specified forecast id.


Securitybearer 
Request 
path Parameters
forecastId
required
string <uuid> 
The forecast id.


 
Responses 
200
Success


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
The specified resource is not found.


get/api/v1/forecasts/{forecastId}
Request samples 
Response samples 
application/json
{
  • "id": "26490e8e-41b9-4ef5-82f7-fdc3428ffbb2",
  • "jobId": "2ea9e9ea-619f-426b-bbbb-33078bef528f",
  • "forecastDate": "2019-01-10",
  • "isFinalized": false,
  • "finalizedDateTime": "2019-01-10T13:12:11Z",
  • "createdDateTime": "2019-01-01T13:12:11Z",
  • "forecastSourceId": "edf9c7b2-af06-4ea6-901b-3866b8943f8a",
  • "productivityType": "unitsPerLaborHour",
  • "createdOnWeb": false,
  • "lastModifiedBy": {
    },
  • "totalBudget": 975000.5,
  • "costAtCompletion": 1000000.5,
  • "costCodeCosts": [
    ],
  • "revenue": [
    ]
}