Compartir a través de

Folders - Create Folder

Servicio:
Core
Versión de la API:
v1

Crea una carpeta en el área de trabajo 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 de área de trabajo superior.

Á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

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
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
parentFolderId

string (uuid)

Identificador de la carpeta primaria. Si no se especifica o null, la carpeta se crea con el área de trabajo como su carpeta primaria.

Respuestas

Nombre Tipo Description
201 Created

Folder

Creado correctamente
Other Status Codes

ErrorResponse

Códigos de error comunes:

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

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

  • InvalidFolderDisplayName: el nombre para mostrar de la carpeta proporcionada no es válido.

  • FolderDepthOutOfRange: la carpeta primaria ha alcanzado la profundidad máxima, no puede crear una subcarpeta nueva.

  • WorkspaceNotSupported: el tipo de área de trabajo especificado no admite folder

.* TooManyFolders: el área de trabajo especificada ha alcanzado el recuento máximo de carpetas, no se puede crear más.

Ejemplos

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

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

{
  "displayName": "A folder"
}

Respuesta de muestra

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

Definiciones

Nombre Description
CreateFolderRequest

Cree una carga de solicitud de carpeta.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
Folder

Objeto folder.

CreateFolderRequest

Object

Cree una carga de solicitud de carpeta.

Nombre Tipo Description
displayName

string

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

string (uuid)

Identificador de la carpeta primaria. Si no se especifica o null, la carpeta se crea con el área de trabajo como su carpeta primaria.

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.