Folders - Create Folder

Serviço:

Core

Versão da API:

v1

Cria uma pasta no workspace especificado.

Note

Essa API faz parte de uma versão prévia e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção.

Permissions

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

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

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

Interface

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
displayName	True	string	O nome de exibição da pasta. O nome deve atender aos requisitos de nome da pasta
parentFolderId		string (uuid)	A ID da pasta pai. Se não for especificado ou nulo, a pasta será criada com o workspace como sua pasta pai.

Respostas

Nome	Tipo	Description
201 Created	Folder	Criado com êxito
Other Status Codes	ErrorResponse	Códigos de erro comuns: FolderDisplayNameAlreadyInUse – O nome de exibição da pasta já está sendo usado. FolderNotFound - A pasta solicitada não foi encontrada no workspace. InvalidFolderDisplayName - O nome de exibição da pasta fornecida é inválido. FolderDepthOutOfRange – A pasta pai atingiu a profundidade máxima, não pode criar uma nova subpasta. WorkspaceNotSupported – O tipo de workspace especificado não dá suporte a Pasta .* TooManyFolders – O workspace 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

Solicitação de exemplo

HTTP

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

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

Resposta de exemplo

Código de status:

201

{
  "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

Solicitação de exemplo

HTTP

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

{
  "displayName": "A folder"
}

Resposta de exemplo

Código de status:

201

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

Definições

Nome	Description
CreateFolderRequest	Criar conteúdo 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

Objeto

Criar conteúdo de solicitação de pasta.

Nome	Tipo	Description
displayName	string	O nome de exibição da pasta. O nome deve atender aos requisitos de nome da pasta
parentFolderId	string (uuid)	A ID da pasta pai. Se não for especificado ou nulo, a pasta será criada com o workspace como sua pasta pai.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

Folder

Objeto

Um objeto de pasta.

Nome	Tipo	Description
displayName	string	O nome de exibição da pasta.
id	string (uuid)	A ID da pasta.
parentFolderId	string (uuid)	A ID da pasta pai. Se a pasta pai for um workspace, parentFolderId não será especificado ou nulo.
workspaceId	string (uuid)	O identificador do espaço de trabalho.