Folders - Get Folder

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

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

Escopos delegados necessários

Workspace.Read.All ou 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

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

Parâmetros do URI

Nome Em Obrigatório Tipo Descrição
folderId
 path True

string (uuid)

O ID da pasta.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Respostas

Nome Tipo Descrição
200 OK

Folder

Pedido concluído com sucesso.
429 Too Many Requests

ErrorResponse

O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais.

Cabeçalhos

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

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

Exemplos

Get a folder example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders/bbbbbbbb-1111-2222-3333-cccccccccccc

Resposta da amostra

Código de estado:
200 
{
  "id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
  "displayName": "A nested folder",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "parentFolderId": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb"
}

Definições

Nome Descrição
ErrorParameter

Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.
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.

ErrorParameter

Object

Um parâmetro estruturado que fornece contexto adicional legível por máquina sobre um erro.

Nome Tipo Descrição
message

string

Uma descrição legível para humanos do significado do parâmetro.
name

string

O identificador de parâmetro.
value

string

O valor do parâmetro.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Descrição
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Nome Tipo Descrição
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.
isRetriable

boolean

Quando confirmado, o pedido pode ser retentado. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message

string

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

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
parameters

ErrorParameter[]

Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Nome Tipo Descrição
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.
parameters

ErrorParameter[]

Parâmetros estruturados que fornecem contexto adicional legível pela máquina sobre o erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

Folder

Object

Um objeto de pasta.

Nome Tipo Descrição
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.