Capacities - Groups CapacityAssignmentStatus

Gets the status of the assignment-to-capacity operation for the specified workspace.

Permissions

Required Scope

Workspace.Read.All and Workspace.ReadWrite.All

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

URI Parameters

Name In Required Type Description
groupId
path True
  • string
uuid

The workspace ID

Responses

Name Type Description
200 OK

OK

Examples

Completed assignment status example
In-progress assignment status example

Completed assignment 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"
}

In-progress assignment 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

The status of a workspace assign-to-capacity operation

WorkspaceCapacityAssignmentStatus

A Power BI response with the status of a workspace assign-to-capacity operation

AssignmentStatus

The status of a workspace assign-to-capacity operation

Name Type Description
AssignmentFailed
  • string

The assignment operation failed

CompletedSuccessfully
  • string

The assignment operation has completed successfully

InProgress
  • string

The assignment operation is in progress

Pending
  • string

The assignment request was received, but the assignment operation hasn't started.

WorkspaceCapacityAssignmentStatus

A Power BI response with the status of a workspace assign-to-capacity operation

Name Type Description
activityId
  • string

The activity ID of the assignment operation (provided in case of an assignment failure).

capacityId
  • string

The capacity ID

endTime
  • string

The end date and time of a workspace assignment operation

startTime
  • string

The start date and time of a workspace assignment operation

status

The status of a workspace assign-to-capacity operation