Partilhar via


Folders - Create Folder

Cria uma pasta no espaço de trabalho especificado.

Note

Esta API faz parte de uma versão de pré-visualização e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base no feedback e não é recomendado para uso em produção.

Permissions

O chamador deve ter a função de colaborador ou de espaço de trabalho superior.

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identity Support
User Yes
Entidade de serviço e identidades geridas Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/folders

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
path True

string (uuid)

O ID do espaço de trabalho.

Corpo do Pedido

Name Necessário Tipo Description
displayName True

string

O nome de exibição da pasta. O nome deve atender requisitos de nome de pasta

parentFolderId

string (uuid)

O ID da pasta pai. Se não for especificada ou nula, a pasta será criada com o espaço de trabalho como sua pasta pai.

Respostas

Name Tipo Description
201 Created

Folder

Criado com sucesso

Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • FolderDisplayNameAlreadyInUse - O nome de exibição da pasta já é usado.

  • FolderNotFound - A pasta solicitada não foi encontrada no espaço de trabalho.

  • InvalidFolderDisplayName - O nome de exibição da pasta fornecida é inválido.

  • FolderDepthOutOfRange - A pasta pai atingiu a profundidade máxima, não é possível criar uma nova subpasta.

  • WorkspaceNotSupported - O tipo de espaço de trabalho especificado não suporta Pasta

.* TooManyFolders - O espaço de trabalho especificado atingiu a contagem máxima de pastas, não pode criar mais.

Exemplos

Create a folder under another folder example
Create a folder with the workspace as its parent folder example

Create a folder under another folder example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders

{
  "displayName": "Q3",
  "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

Resposta da amostra

{
  "id": "ffffffff-5555-6666-7777-aaaaaaaaaaaa",
  "displayName": "Q3",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "parentFolderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

Create a folder with the workspace as its parent folder example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders

{
  "displayName": "A folder"
}

Resposta da amostra

{
  "id": "eeeeeeee-4444-5555-6666-ffffffffffff",
  "displayName": "A folder",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
}

Definições

Name Description
CreateFolderRequest

Criar carga útil de solicitação de pasta.

ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

ErrorResponse

A resposta de erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

Folder

Um objeto de pasta.

CreateFolderRequest

Criar carga útil de solicitação de pasta.

Name Tipo Description
displayName

string

O nome de exibição da pasta. O nome deve atender requisitos de nome de pasta

parentFolderId

string (uuid)

O ID da pasta pai. Se não for especificada ou nula, a pasta será criada com o espaço de trabalho como sua pasta pai.

ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.

resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.

message

string

Uma representação legível por humanos do erro.

moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.

relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.

message

string

Uma representação legível por humanos do erro.

relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

Folder

Um objeto de pasta.

Name Tipo Description
displayName

string

O nome de exibição da pasta.

id

string (uuid)

O ID da pasta.

parentFolderId

string (uuid)

O ID da pasta pai. Se a pasta pai for um espaço de trabalho, parentFolderId não será especificado ou nulo.

workspaceId

string (uuid)

O ID do espaço de trabalho.