Dataset refresh history entity

Updated: July 21, 2017

A Dataset refresh history entity is a JSON representation of an entry within the refresh history for a given dataset.

Content-Type

application/json

Parameters

Parameter	Type	Description
id	Read-only	Id of this refresh history. No particular use, except for problem investigations.
refreshType	Read-only	'Scheduled' for PBI scheduled refresh 'OnDemand' for PBI UI On-demand refresh 'ViaApi' for refresh executed via this API
startTime	Read-only	DateTime of start
endtime	Read-only	DateTime of termination (may be empty, if refresh is progress)
status	Read-only	'Unknown' = unknown completion state, or refresh is in progress. endTime will be empty with this status. 'Completed' = refresh completed successfully 'Failed' = refresh failed. serviceExceptionJson will contain the error. 'Disabled' = refresh disabled by Selective Refresh
serviceExceptionJson	Read-only	Json formatted failure exception details, including the cluster, time, Request and Activity IDs (only on error)

Schema

{
  "id": "string",
  "refreshType": "string",
  "startTime": "2017-07-21T21:27:11.057Z",
  "endTime": "2017-07-21T21:27:11.057Z",
  "serviceExceptionJson": "string",
  "status": "string"
}

Example

Completed

{
    "id": "823456",
    "refreshType": "Scheduled",
    "startTime": "2017-06-13T09:25:43.153Z",
    "endTime": "2017-06-13T09:31:43.153Z",
    "status": "Completed",
    "ServiceExceptionJson": empty
}

In Progress

{
    "id": "823456",
    "refreshType": "Scheduled",
    "startTime": "2017-06-13T09:25:43.153Z",
    "endTime": empty,
    "status": "Unknown",
    "ServiceExceptionJson": empty
}