Partilhar via

Folders - Update Folder

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

Atualiza as propriedades da pasta especificada.

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

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

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

Parâmetros do URI

Name Em Necessário Tipo Description
folderId
 path True

string (uuid)

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

Respostas

Name Tipo Description
200 OK

Folder

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

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

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

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

Exemplos

Update a folder example

Pedido de amostra

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 da amostra

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

Definições

Name 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

Solicitação de pasta de atualização.

ErrorRelatedResource

Object

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

Object

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

Object

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

Object

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.

UpdateFolderRequest

Object

Solicitação de pasta de atualização.

Name Tipo Description
displayName

string

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