Compartilhar via

Folders - Update Folder

Serviço:
Core
Versão da API:
v1

Atualiza as propriedades da pasta especificada.

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 colaborador ou função superior no workspace.

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

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
folderId
 path True

string (uuid)

A ID da pasta.
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

Respostas

Nome Tipo Description
200 OK

Folder

Solicitação concluída com êxito.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • FolderNotFound - A pasta solicitada não foi encontrada no workspace.

  • FolderDisplayNameAlreadyInUse – O nome de exibição da pasta já está sendo usado.

  • InvalidFolderDisplayName - O nome da pasta fornecido é inválido, como incluir caracteres inválidos.

Exemplos

Update a folder example

Solicitação de exemplo

PATCH https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders/aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb

{
  "displayName": "A new Folder name"
}

Resposta de exemplo

Código de status:
200 
{
  "id": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb",
  "displayName": "A new Folder name",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
}

Definições

Nome Description
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.
UpdateFolderRequest

Atualizar solicitação de pasta.

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.

UpdateFolderRequest

Objeto

Atualizar 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