Admin - Get Refreshable For Capacity
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}
GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}?$expand={$expand}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
capacity
|
path | True |
|
The capacity id |
refreshable
|
path | True |
|
The refreshable id |
$expand
|
query |
|
Expands related entities inline, receives a comma-separated list of data types. Supported: capacities and groups |
Responses
Name | Type | Description |
---|---|---|
200 OK |
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
{
"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
{
"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 |
Capacity |
The capacity state |
capacity |
Access right user has on the capacity |
Dashboard |
A Power BI dashboard |
Dataflow |
The metadata of a dataflow |
Dataset |
A Power BI dataset |
Datasource |
Datasource usage |
Dependent |
A Power BI Dependent dataflow |
Encryption |
Encryption information for a dataset |
Encryption |
Dataset encryption status |
Endorsement |
Power BI endorsement details |
Group |
A Power BI group |
Group |
A Power BI user access right entry for workspace |
Group |
Access rights user has for the workspace |
Principal |
The principal type |
Refresh |
A Power BI refresh history entry |
Refreshable |
A Power BI refreshable |
Refreshable |
The refreshable kind |
Refreshables |
Power BI refreshable list |
Refresh |
A Power BI refresh schedule for cached model |
Refresh |
Type of refresh request |
Report |
A Power BI report |
Schedule |
Notification option at scheduled refresh termination |
Sensitivity |
Artifact sensitivity label info |
Tenant |
Encryption key information |
Tile |
A Power BI tile |
Workbook |
A Power BI workbook |
Capacity
A Power BI capacity
Name | Type | Description |
---|---|---|
admins |
|
An array of capacity admins. |
capacityUserAccessRight |
Access right user has on the capacity |
|
displayName |
|
The capacity display name |
id |
|
The capacity id |
region |
|
The Azure region where the capacity is provisioned |
sku |
|
The capacity SKU. |
state |
The capacity state |
|
tenantKey |
Encryption key information (Only applicable for admin route) |
|
tenantKeyId |
|
The id of the encryption key (Only applicable for admin route) |
CapacityState
The capacity state
Name | Type | Description |
---|---|---|
Active |
|
Capacity ready for use |
Deleted |
|
Capacity has been deleted and is not available |
Deleting |
|
Capacity in process of being deleted |
Invalid |
|
Capacity can not be used |
NotActivated |
|
Not Supported |
PreSuspended |
|
Not Supported |
ProvisionFailed |
|
Capacity failed to provisioned |
Provisioning |
|
Capacity in activation process |
Suspended |
|
Capacity suspended for use |
UpdatingSku |
|
Capacity Sku change is in progress |
capacityUserAccessRight
Access right user has on the capacity
Name | Type | Description |
---|---|---|
Admin |
|
User has administrator rights on the capacity |
Assign |
|
User can assign workspaces to the capacity |
None |
|
User doesn't have access to the capacity |
Dashboard
A Power BI dashboard
Name | Type | Description |
---|---|---|
dataClassification |
|
The data classification tag of the dashboard |
displayName |
|
The dashboard display name |
embedUrl |
|
The dashboard embed url |
id |
|
The dashboard id |
isReadOnly |
|
Is ReadOnly dashboard |
sensitivityLabel |
The dashboard sensitivity label |
|
tiles |
|
The tiles that belong to the dashboard. |
Dataflow
The metadata of a dataflow
Name | Type | Description |
---|---|---|
configuredBy |
|
The dataflow owner |
datasourceUsages |
Datasource usages |
|
description |
|
The dataflow description |
endorsementDetails |
The dataflow endorsement details |
|
modelUrl |
|
A URL to the dataflow definition file (model.json) |
modifiedBy |
|
The user that modified this dataflow |
modifiedDateTime |
|
modification date time |
name |
|
The dataflow name |
objectId |
|
The dataflow id |
sensitivityLabel |
The dataflow sensitivity label |
|
upstreamDataflows |
Upstream Dataflows |
Dataset
A Power BI dataset
Name | Type | Description |
---|---|---|
ContentProviderType |
|
The content provider type for the dataset |
CreateReportEmbedURL |
|
The dataset create report embed url |
CreatedDate |
|
DateTime of creation of this dataset |
Encryption |
The dataset encryption information (Only applicable when $expand is specified) |
|
IsEffectiveIdentityRequired |
|
Whether the dataset requires an effective identity. This indicates that you must send an effective identity using the GenerateToken API. |
IsEffectiveIdentityRolesRequired |
|
Whether RLS is defined inside the PBIX file. This indicates that you must specify a role. |
IsOnPremGatewayRequired |
|
Dataset requires an On-premises Data Gateway |
IsRefreshable |
|
Can this dataset be refreshed |
QnaEmbedURL |
|
The dataset qna embed url |
addRowsAPIEnabled |
|
Whether the dataset allows adding new rows |
configuredBy |
|
The dataset owner |
datasourceUsages |
Datasource usages |
|
description |
|
The dataset description |
endorsementDetails |
The dataset endorsement details |
|
id |
|
The dataset id |
name |
|
The dataset name |
sensitivityLabel |
The dataset sensitivity label |
|
upstreamDataflows |
Upstream Dataflows |
|
webUrl |
|
The dataset web url |
DatasourceUsage
Datasource usage
Name | Type | Description |
---|---|---|
datasourceInstanceId |
|
The datasource instance ID |
DependentDataflow
A Power BI Dependent dataflow
Name | Type | Description |
---|---|---|
groupId |
|
The target group id |
targetDataflowId |
|
The target dataflow id |
Encryption
Encryption information for a dataset
Name | Type | Description |
---|---|---|
EncryptionStatus |
Dataset encryption status |
EncryptionStatus
Dataset encryption status
Name | Type | Description |
---|---|---|
InSyncWithWorkspace |
|
Encryption is supported and is in sync with the encryption settings |
NotInSyncWithWorkspace |
|
Encryption is supported and not in sync with the encryption settings |
NotSupported |
|
Encryption is not supported for this dataset |
Unknown |
|
Unable to determine state due to dataset corruption |
EndorsementDetails
Power BI endorsement details
Name | Type | Description |
---|---|---|
certifiedBy |
|
The user that certified the artifact |
endorsement |
|
The endorsement status |
Group
A Power BI group
Name | Type | Description |
---|---|---|
capacityId |
|
The capacity id |
dashboards |
The dashboards that belong to the group. Available only for admin API calls. |
|
dataflowStorageId |
|
The Power BI dataflow storage account id |
dataflows |
|
The dataflows that belong to the group. Available only for admin API calls. |
datasets |
|
The datasets that belong to the group. Available only for admin API calls. |
description |
|
The group description. Available only for admin API calls. |
id |
|
The workspace id |
isOnDedicatedCapacity |
|
Is the group on dedicated capacity |
isReadOnly |
|
Is the group read only |
name |
|
The group name |
reports |
|
The reports that belong to the group. Available only for admin API calls. |
state |
|
The group state. Available only for admin API calls. |
type |
|
The type of group. Available only for admin API calls. |
users |
The users that belong to the group, and their access rights. Available only for admin API calls. |
|
workbooks |
|
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 |
|
Display name of the principal |
emailAddress |
|
Email address of the user |
groupUserAccessRight |
Access rights user has for the workspace |
|
identifier |
|
Identifier of the principal |
principalType |
The principal type |
GroupUserAccessRight
Access rights user has for the workspace
Name | Type | Description |
---|---|---|
Admin |
|
Grants administrator rights to workspace |
Contributor |
|
Grants Read and Explore access to content in group |
Member |
|
Grants Read, Reshare and Explore access to content in workspace |
None |
|
Removes permission to content in workspace |
Viewer |
|
Grants Read only access to content in group |
PrincipalType
The principal type
Name | Type | Description |
---|---|---|
App |
|
Service principal type |
Group |
|
Group principal type |
User |
|
User principal type |
Refresh
A Power BI refresh history entry
Name | Type | Description |
---|---|---|
endTime |
|
DateTime of termination (may be empty if refresh is progress) |
refreshType |
Type of refresh request |
|
requestId |
|
The identifier of the Refresh request. |
serviceExceptionJson |
|
Failure error code in json format (not empty only on error). |
startTime |
|
DateTime of start |
status |
|
'Unknown' - Unknown completion state or refresh is in progress. endTime will be empty with this status. |
Refreshable
A Power BI refreshable
Name | Type | Description |
---|---|---|
averageDuration |
|
The average duration in seconds of a refresh within the summary time window |
capacity |
The capacity for the refreshable item |
|
configuredBy |
|
Refreshable owners |
endTime |
|
The end time of the window for which summary data exists |
group |
The associated group for the refreshable item |
|
id |
|
Object id of refreshable |
kind |
The refreshable kind |
|
lastRefresh |
The last Power BI refresh history entry for the refreshable item |
|
medianDuration |
|
The median duration in seconds of a refresh within the summary time window |
name |
|
Display name of refreshable |
refreshCount |
|
The number of refreshes within the summary time window |
refreshFailures |
|
The number of refresh failures within the summary time window |
refreshSchedule |
The refresh schedule for the refreshable item |
|
refreshesPerDay |
|
The number of refreshes per day within the summary time window |
startTime |
|
The start time of the window for which summary data exists |
RefreshableKind
The refreshable kind
Name | Type | Description |
---|---|---|
Dataset |
|
Dataset |
Refreshables
Power BI refreshable list
Name | Type | Description |
---|---|---|
odata.context |
|
OData context |
value |
The refreshables |
RefreshSchedule
A Power BI refresh schedule for cached model
Name | Type | Description |
---|---|---|
NotifyOption |
Notification option at scheduled refresh termination |
|
days |
|
Days to execute the refresh |
enabled |
|
Is the refresh enabled |
localTimeZoneId |
|
The Id of the Time zone to use. See Time Zone Info. |
times |
|
Times to execute the refresh within each day |
RefreshType
Type of refresh request
Name | Type | Description |
---|---|---|
OnDemand |
|
Refresh was triggered interactively threw Power BI portal |
Scheduled |
|
Refresh was triggered by the dataset refresh schedule setting |
ViaApi |
|
Refresh was triggered by an Api call |
Report
A Power BI report
Name | Type | Description |
---|---|---|
createdBy |
|
The report owner |
createdDateTime |
|
The report created date time. |
datasetId |
|
The dataset id |
description |
|
The report description |
embedUrl |
|
The report embed url |
endorsementDetails |
The report endorsement details |
|
id |
|
The report id |
modifiedBy |
|
The user that modified this report |
modifiedDateTime |
|
The report modified date time. |
name |
|
The report name |
reportType |
enum:
|
The report type |
sensitivityLabel |
The report sensitivity label |
|
webUrl |
|
The report web url |
ScheduleNotifyOption
Notification option at scheduled refresh termination
Name | Type | Description |
---|---|---|
MailOnFailure |
|
Mail notification will be sent on refresh failure |
NoNotification |
|
No notification will be sent |
SensitivityLabel
Artifact sensitivity label info
Name | Type | Description |
---|---|---|
labelId |
|
The sensitivity label ID |
TenantKey
Encryption key information
Name | Type | Description |
---|---|---|
createdAt |
|
Encryption key creation time |
id |
|
The id of the encryption key |
isDefault |
|
Indicates that this key is set as default for the entire tenant. Any new capacity creation will inherit this key upon creation |
keyVaultKeyIdentifier |
|
Uri to the version of the Azure Key Vault key |
name |
|
The name of the encryption key |
updatedAt |
|
Encryption key last update time |
Tile
A Power BI tile
Name | Type | Description |
---|---|---|
colSpan |
|
number of columns a tile should span |
datasetId |
|
The dataset id. Available only for tiles created from a report or using a dataset; for example, Q&A tiles. |
embedData |
|
The tile embed data |
embedUrl |
|
The tile embed url |
id |
|
The tile id |
reportId |
|
The report id. Available only for tiles created from a report. |
rowSpan |
|
number of rows a tile should span |
title |
|
The dashboard display name |
Workbook
A Power BI workbook
Name | Type | Description |
---|---|---|
datasetId |
|
DatasetId for workbooks. Only applies for workbooks that has an associated dataset. |
name |
|
The workbook name |