Admin - Get Refreshable For Capacity

Service:: Power BI REST APIs

API Version:: v1.0

Returns the specified refreshable for the specified capacity the user has access to
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}?$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
capacityId	path	True	string uuid	The capacity id
refreshableId	path	True	string	The refreshable id
$expand	query		string	Expands related entities inline, receives a comma-separated list of data types. Supported: capacities and groups

Responses

Name	Type	Description
200 OK	Refreshables	OK

Examples

Example

Get refreshable with capacity and group expanded

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ]
    }
  ]
}

Get refreshable with capacity and group expanded

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}?$expand=capacity,group

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ],
      "capacity": {
        "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
        "displayName": "MyCapacity",
        "sku": "A1"
      },
      "group": {
        "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
        "name": "SalesMarketing"
      }
    }
  ]
}

Definitions

Capacity	A Power BI capacity
CapacityState	The capacity state
capacityUserAccessRight	Access right user has on the capacity
Dashboard	A Power BI dashboard
Dataflow	The metadata of a dataflow
Dataset	A Power BI dataset
Encryption	Encryption information for a dataset
EncryptionStatus	Dataset encryption status
Group	A Power BI group
GroupUser	A Power BI user access right entry for workspace
GroupUserAccessRight	Access rights user has for the workspace
PrincipalType	The principal type
Refresh	A Power BI refresh history entry
Refreshable	A Power BI refreshable
RefreshableKind	The refreshable kind
Refreshables	Power BI refreshable list
RefreshSchedule	A Power BI refresh schedule for cached model
RefreshType	Type of refresh request
Report	A Power BI report
ScheduleNotifyOption	Notification option at scheduled refresh termination
TenantKey	Encryption key information
Tile	A Power BI tile
Workbook	A Power BI workbook

Capacity

A Power BI capacity

Name	Type	Description
admins	string[]	An array of capacity admins.
capacityUserAccessRight	capacityUserAccessRight	Access right user has on the capacity
displayName	string	The capacity display name
id	string	The capacity id
region	string	The Azure region where the capacity is provisioned
sku	string	The capacity SKU.
state	CapacityState	The capacity state
tenantKey	TenantKey	Encryption key information (Only applicable for admin route)
tenantKeyId	string	The id of the encryption key (Only applicable for admin route)

CapacityState

The capacity state

Name	Type	Description
Active	string	Capacity ready for use
Deleted	string	Capacity has been deleted and is not available
Deleting	string	Capacity in process of being deleted
Invalid	string	Capacity can not be used
NotActivated	string	Not Supported
PreSuspended	string	Not Supported
ProvisionFailed	string	Capacity failed to provisioned
Provisioning	string	Capacity in activation process
Suspended	string	Capacity suspended for use
UpdatingSku	string	Capacity Sku change is in progress

capacityUserAccessRight

Access right user has on the capacity

Name	Type	Description
Admin	string	User has administrator rights on the capacity
Assign	string	User can assign workspaces to the capacity
None	string	User doesn't have access to the capacity

Dashboard

A Power BI dashboard

Name	Type	Description
displayName	string	The dashboard display name
embedUrl	string	The dashboard embed url
id	string	The dashboard id
isReadOnly	boolean	Is ReadOnly dashboard
tiles	Tile[]	The tiles that belong to the dashboard.

Dataflow

The metadata of a dataflow

Name	Type	Description
configuredBy	string	The dataflow owner
description	string	The dataflow description
modelUrl	string	A URL to the dataflow definition file (model.json)
name	string	The dataflow name
objectId	string	The dataflow id

Dataset

A Power BI dataset

Name	Type	Description
ContentProviderType	string	The content provider type for the dataset
CreatedDate	string	DateTime of creation of this dataset
Encryption	Encryption	The dataset encryption information (Only applicable when $expand is specified)
IsEffectiveIdentityRequired	boolean	Whether the dataset requires an effective identity. This indicates that you must send an effective identity using the GenerateToken API.
IsEffectiveIdentityRolesRequired	boolean	Whether RLS is defined inside the PBIX file. This indicates that you must specify a role.
IsOnPremGatewayRequired	boolean	Dataset requires an On-premises Data Gateway
IsRefreshable	boolean	Can this dataset be refreshed
addRowsAPIEnabled	boolean	Whether the dataset allows adding new rows
configuredBy	string	The dataset owner
id	string	The dataset id
name	string	The dataset name
webUrl	string	The dataset web url

Encryption

Encryption information for a dataset

Name	Type	Description
EncryptionStatus	EncryptionStatus	Dataset encryption status

EncryptionStatus

Dataset encryption status

Name	Type	Description
InSyncWithWorkspace	string	Encryption is supported and is in sync with the encryption settings
NotInSyncWithWorkspace	string	Encryption is supported and not in sync with the encryption settings
NotSupported	string	Encryption is not supported for this dataset
Unknown	string	Unable to determine state due to dataset corruption

Group

A Power BI group

Name	Type	Description
capacityId	string	The capacity id
dashboards	Dashboard[]	The dashboards that belong to the group. Available only for admin API calls.
dataflowStorageId	string	The Power BI dataflow storage account id
dataflows	Dataflow[]	The dataflows that belong to the group. Available only for admin API calls.
datasets	Dataset[]	The datasets that belong to the group. Available only for admin API calls.
description	string	The group description. Available only for admin API calls.
id	string	The workspace id
isOnDedicatedCapacity	boolean	Is the group on dedicated capacity
isReadOnly	boolean	Is the group read only
name	string	The group name
reports	Report[]	The reports that belong to the group. Available only for admin API calls.
state	string	The group state. Available only for admin API calls.
type	string	The type of group. Available only for admin API calls.
users	GroupUser[]	The users that belong to the group, and their access rights. Available only for admin API calls.
workbooks	Workbook[]	The workbooks that belong to the group. Available only for admin API calls.

GroupUser

A Power BI user access right entry for workspace

Name	Type	Description
displayName	string	Display name of the principal
emailAddress	string	Email address of the user
groupUserAccessRight	GroupUserAccessRight	Access rights user has for the workspace
identifier	string	Identifier of the principal
principalType	PrincipalType	The principal type

GroupUserAccessRight

Access rights user has for the workspace

Name	Type	Description
Admin	string	Grants administrator rights to workspace
Contributor	string	Grants read and write access to content in group
Member	string	Grants read access to content in workspace
None	string	Removes permission to content in workspace

PrincipalType

The principal type

Name	Type	Description
App	string	Service principal type
Group	string	Group principal type
User	string	User principal type

Refresh

A Power BI refresh history entry

Name	Type	Description
endTime	string	DateTime of termination (may be empty if refresh is progress)
refreshType	RefreshType	Type of refresh request
requestId	string	The identifier of the Refresh request. Please provide this identifier in all service requests
serviceExceptionJson	string	Failure error code in json format (not empty only on error).
startTime	string	DateTime of start
status	string	'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.

Refreshable

A Power BI refreshable

Name	Type	Description
averageDuration	number	The average duration in seconds of a refresh within the summary time window
capacity	Capacity	The capacity for the refreshable item
configuredBy	string[]	Refreshable owners
endTime	string	The end time of the window for which summary data exists
group	Group	The associated group for the refreshable item
id	string	Object id of refreshable
kind	RefreshableKind	The refreshable kind
lastRefresh	Refresh	The last Power BI refresh history entry for the refreshable item
medianDuration	number	The median duration in seconds of a refresh within the summary time window
name	string	Display name of refreshable
refreshCount	integer	The number of refreshes within the summary time window
refreshFailures	integer	The number of refresh failures within the summary time window
refreshSchedule	RefreshSchedule	The refresh schedule for the refreshable item
refreshesPerDay	integer	The number of refreshes per day within the summary time window
startTime	string	The start time of the window for which summary data exists

RefreshableKind

The refreshable kind

Name	Type	Description
Dataset	string	Dataset

Refreshables

Power BI refreshable list

Name	Type	Description
odata.context	string	OData context
value	Refreshable[]	The refreshables

RefreshSchedule

A Power BI refresh schedule for cached model

Name	Type	Description
NotifyOption	ScheduleNotifyOption	Notification option at scheduled refresh termination
days	string[]	Days to execute the refresh
enabled	boolean	Is the refresh enabled
localTimeZoneId	string	The Id of the Time zone to use. See Name of Time Zone column in Microsoft Time Zone Index Values.
times	string[]	Times to execute the refresh within each day

RefreshType

Type of refresh request

Name	Type	Description
OnDemand	string	Refresh was triggered interactively threw Power BI portal
Scheduled	string	Refresh was triggered by the dataset refresh schedule setting
ViaApi	string	Refresh was triggered by an Api call

Report

A Power BI report

Name	Type	Description
datasetId	string	The dataset id
embedUrl	string	The report embed url
id	string	The report id
name	string	The report name
webUrl	string	The report web url

ScheduleNotifyOption

Notification option at scheduled refresh termination

Name	Type	Description
MailOnFailure	string	Mail notification will be sent on refresh failure
NoNotification	string	No notification will be sent

TenantKey

Encryption key information

Name	Type	Description
createdAt	string	Encryption key creation time
id	string	The id of the encryption key
isDefault	boolean	Indicates that this key is set as default for the entire tenant. Any new capacity creation will inherit this key upon creation
keyVaultKeyIdentifier	string	Uri to the version of the Azure Key Vault key
name	string	The name of the encryption key
updatedAt	string	Encryption key last update time

Tile

A Power BI tile

Name	Type	Description
colSpan	integer	number of columns a tile should span
datasetId	string	The dataset id. Available only for tiles created from a report or using a dataset; for example, Q&A tiles.
embedData	string	The tile embed data
embedUrl	string	The tile embed url
id	string	The tile id
reportId	string	The report id. Available only for tiles created from a report.
rowSpan	integer	number of rows a tile should span
title	string	The dashboard display name

Workbook

A Power BI workbook

Name	Type	Description
datasetId	string	DatasetId for workbooks. Only applies for workbooks that has an associated dataset.
name	string	The workbook name

Admin - Get Refreshable For Capacity

URI Parameters

Responses

Examples

Example

Sample Request

Sample Response

Get refreshable with capacity and group expanded

Sample Request

Sample Response

Definitions

Capacity

CapacityState

capacityUserAccessRight

Dashboard

Dataflow

Dataset

Encryption

EncryptionStatus

Group

GroupUser

GroupUserAccessRight

PrincipalType

Refresh

Refreshable

RefreshableKind

Refreshables

RefreshSchedule

RefreshType

Report

ScheduleNotifyOption

TenantKey

Tile

Workbook

Is this page helpful?

Is this page helpful?