Workspaces - Get Workspace
Note
This API is in preview.
Returns information of the specified workspace.
Permissions
The caller must have viewer or higher role on the workspace.
Required Delegated Scopes
Workspace.Read.All or Workspace.ReadWrite.All
Interface
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
The workspace ID. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
Examples
Get a workspace example
Sample Request
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227
Sample Response
{
"id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
"displayName": "New workspace",
"description": "New workspace description",
"type": "Workspace",
"capacityId": "56bac802-080d-4f73-8a42-1b406eb1fcac",
"capacityAssignmentProgress": "Completed"
}
Definitions
Name | Description |
---|---|
Capacity |
A Workspace assignment to capacity progress status. Additional capacity assignment progress values may be added over time. |
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Workspace |
A workspace object. |
Workspace |
A Workspace type. Additional Workspace types may be added over time. |
CapacityAssignmentProgress
A Workspace assignment to capacity progress status. Additional capacity assignment progress values may be added over time.
Name | Type | Description |
---|---|---|
Completed |
string |
Last capacity assignment operation was completed successfully. |
Failed |
string |
Capacity assignment operation has encountered an error or failure and was unable to complete. |
InProgress |
string |
Capacity assignment operation is currently running and has not yet completed. |
ErrorRelatedResource
The error related resource details object.
Name | Type | Description |
---|---|---|
resourceId |
string |
The resource ID that's involved in the error. |
resourceType |
string |
The type of the resource that's involved in the error. |
ErrorResponse
The error response.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
moreDetails |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
ErrorResponseDetails
The error response details.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
relatedResource |
The error related resource details. |
WorkspaceInfo
A workspace object.
Name | Type | Description |
---|---|---|
capacityAssignmentProgress |
The status of the workspace's capacity assignment progress. |
|
capacityId |
string |
The ID of the capacity the workspace is assigned to. |
description |
string |
The workspace description. |
displayName |
string |
The workspace display name. |
id |
string |
The workspace ID. |
type |
The workspace type. |
WorkspaceType
A Workspace type. Additional Workspace types may be added over time.
Name | Type | Description |
---|---|---|
Personal |
string |
A personal workspace |
Workspace |
string |
A collaborative workspace |