Share via

Capacities - Groups CapacityAssignmentStatusMyWorkspace

Service:
Power BI REST APIs
API Version:
v1.0

Gets the status of the My workspace assignment-to-capacity operation.

Required Scope

Workspace.Read.All and Workspace.ReadWrite.All 

GET https://api.powerbi.com/v1.0/myorg/CapacityAssignmentStatus

Responses

Name Type Description
200 OK

WorkspaceCapacityAssignmentStatus

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/CapacityAssignmentStatus

Sample response

Status code:
200 
{
  "status": "CompletedSuccessfully",
  "activityId": "dec4010c-9aad-edb6-0063-94b313cfe121",
  "startTime": "2017-06-13T09:25:43.153Z",
  "endTime": "2017-06-13T09:26:43.153Z",
  "capacityId": "00000000-0000-0000-0000-000000000000"
}

In-progress assignment status example

Sample request

GET https://api.powerbi.com/v1.0/myorg/CapacityAssignmentStatus

Sample response

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

Definitions

Name Description
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

Enumeration

The status of a workspace assign-to-capacity operation

Value Description
Pending

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

The assignment operation is in progress
CompletedSuccessfully

The assignment operation has completed successfully
AssignmentFailed

The assignment operation failed

WorkspaceCapacityAssignmentStatus

Object

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

Name Type Description
activityId

string (uuid)

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

string (uuid)

The capacity ID
endTime

string (date-time)

The end date and time of a workspace assignment operation
startTime

string (date-time)

The start date and time of a workspace assignment operation
status

AssignmentStatus

The status of a workspace assign-to-capacity operation