Compartir a través de

Folders - Update Folder

Servicio:
Core
Versión de la API:
v1

Actualiza las propiedades de la carpeta especificada.

Note

Esta API forma parte de una versión preliminar y solo se proporciona con fines de evaluación y desarrollo. Puede cambiar en función de los comentarios y no se recomienda para su uso en producción.

Permissions

El autor de la llamada debe tener un rol de colaborador o superior en el área de trabajo.

Ámbitos delegados necesarios

Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identity Support
User Yes
Entidad de servicio e Identidades administradas Yes

Interface

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
folderId
 path True

string (uuid)

Identificador de carpeta.
workspaceId
 path True

string (uuid)

Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
displayName True

string

Nombre para mostrar de la carpeta. El nombre debe cumplir requisitos de nombre de carpeta

Respuestas

Nombre Tipo Description
200 OK

Folder

Solicitud completada correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • FolderNotFound: no se encontró la carpeta solicitada en el área de trabajo.

  • FolderDisplayNameAlreadyInUse: ya se usa el nombre para mostrar de la carpeta.

  • InvalidFolderDisplayName: el nombre de carpeta proporcionado no es válido, como incluir caracteres no válidos.

Ejemplos

Update a folder example

Solicitud de ejemplo

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

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

Respuesta de muestra

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

Definiciones

Nombre Description
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
Folder

Objeto folder.
UpdateFolderRequest

Actualizar solicitud de carpeta.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

Folder

Object

Objeto folder.

Nombre Tipo Description
displayName

string

Nombre para mostrar de la carpeta.
id

string (uuid)

Identificador de carpeta.
parentFolderId

string (uuid)

Identificador de la carpeta primaria. Si la carpeta primaria es un área de trabajo, parentFolderId no se especifica ni es null.
workspaceId

string (uuid)

Identificador del área de trabajo.

UpdateFolderRequest

Object

Actualizar solicitud de carpeta.

Nombre Tipo Description
displayName

string

Nombre para mostrar de la carpeta. El nombre debe cumplir requisitos de nombre de carpeta