Capacities - Groups CapacityAssignmentStatus

Gets the status of the assignment to capacity operation of the specified workspace.
Note: To perform this operation, the user must be admin on the specified workspace.

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

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/CapacityAssignmentStatus

URI Parameters

Name In Required Type Description
groupId
path True
  • string

The workspace id

Responses

Name Type Description
200 OK

OK

Examples

Assignment completed successfully status example
Assignment in progress status example

Assignment completed successfully status example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/CapacityAssignmentStatus

Sample Response

{
  "status": "CompletedSuccessfully",
  "activityId": "dec4010c-9aad-edb6-0063-94b313cfe121",
  "startTime": "2017-06-13T09:25:43.153Z",
  "endTime": "2017-06-13T09:26:43.153Z",
  "capacityId": "EC719732-EC80-4034-8053-0026BD5996D4"
}

Assignment in progress status example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/CapacityAssignmentStatus

Sample Response

{
  "status": "InProgress",
  "startTime": "2017-06-13T09:25:43.153Z",
  "capacityId": "EC719732-EC80-4034-8053-0026BD5996D4"
}

Definitions

AssignmentStatus

Workspace assignment status

WorkspaceCapacityAssignmentStatus

Power BI workspace assignment status to capacity response

AssignmentStatus

Workspace assignment status

Name Type Description
AssignmentFailed
  • string

Assignment failed

CompletedSuccessfully
  • string

Assignment operation was completed successfully

InProgress
  • string

Assignment operation is in progress

Pending
  • string

Assignment request was initiated, but was not started yet

WorkspaceCapacityAssignmentStatus

Power BI workspace assignment status to capacity response

Name Type Description
activityId
  • string

The activity id of the acctual assignment operation, can be provided in case of assignment failures

capacityId
  • string

The capacity id

endTime
  • string

End time of workspace assignment operation

startTime
  • string

Start time of workspace assignment operation

status

Workspace assignment status