Workspaces - Create Workspace

Service:

Core

API Version:

v1

Note

This API is in preview.

Creates a new workspace.

Permissions

• The caller must have permission to create workspaces granted by the tenant admin. For more information see create workspaces.
• The caller must have contributor permissions or be an Admin on the capacity. For more information, see capacity user permissions.

Required Delegated Scopes

Workspace.ReadWrite.All

Interface

POST https://api.fabric.microsoft.com/v1/workspaces

Request Body

Name	Required	Type	Description
displayName	True	string	The workspace display name. The display name cannot contain more than 256 characters. Only unused workspace names are allowed. "Admin monitoring" is a reserved workspace name.
capacityId		string	The ID of the capacity to assign the workspace to.
description		string	The workspace description. The description cannot contain more than 4000 characters.

Responses

Name	Type	Description
201 Created	Workspace	Successfully created. Headers Location: string
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Examples

Create a workspace example

Sample Request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces

{
  "displayName": "New workspace"
}

Sample Response

Status code:

201

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb22287ff

Response Body

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb22287ff",
  "displayName": "New workspace",
  "description": "",
  "type": "Workspace"
}

Definitions

Name	Description
CreateWorkspaceRequest	Create workspace request payload.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
Workspace	A workspace object.
WorkspaceType	A Workspace type. Additional Workspace types may be added over time.

CreateWorkspaceRequest

Create workspace request payload.

Name	Type	Description
capacityId	string	The ID of the capacity to assign the workspace to.
description	string	The workspace description. The description cannot contain more than 4000 characters.
displayName	string	The workspace display name. The display name cannot contain more than 256 characters. Only unused workspace names are allowed. "Admin monitoring" is a reserved workspace name.

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	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	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	ErrorRelatedResource	The error related resource details.

Workspace

A workspace object.

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