Folders - Create Folder

Service:

Core

Version d'API:

v1

Crée un dossier dans l’espace de travail spécifié.

Note

Cette API fait partie d’une préversion et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production.

Permissions

L’appelant doit avoir rôle de contributeur ou supérieur.

Étendues déléguées requises

Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity	Support
User	Yes
Service principal et identités gérées	Yes

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.

Corps de la demande

Nom	Obligatoire	Type	Description
displayName	True	string	Nom complet du dossier. Le nom doit respecter conditions requises pour le nom du dossier
parentFolderId		string (uuid)	ID du dossier parent. S’il n’est pas spécifié ou null, le dossier est créé avec l’espace de travail en tant que dossier parent.

Réponses

Nom	Type	Description
201 Created	Folder	Création réussie
Other Status Codes	ErrorResponse	Codes d’erreur courants : FolderDisplayNameAlreadyInUse : le nom d’affichage du dossier est déjà utilisé. FolderNotFound : le dossier demandé n’a pas été trouvé dans l’espace de travail. InvalidFolderDisplayName : le nom complet du dossier fourni n’est pas valide. FolderDepthOutOfRange : le dossier parent a atteint une profondeur maximale, ne peut pas créer de sous-dossier. WorkspaceNotSupported : le type d’espace de travail spécifié ne prend pas en charge le dossier .* TooManyFolders : l’espace de travail spécifié a atteint le nombre maximal de dossiers, ne peut plus être créé.

Exemples

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

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:

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

Exemple de requête

HTTP

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

{
  "displayName": "A folder"
}

Exemple de réponse

Code d’état:

201

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

Définitions

Nom	Description
CreateFolderRequest	Créez une charge utile de demande de dossier.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
Folder	Objet folder.

CreateFolderRequest

Object

Créez une charge utile de demande de dossier.

Nom	Type	Description
displayName	string	Nom complet du dossier. Le nom doit respecter conditions requises pour le nom du dossier
parentFolderId	string (uuid)	ID du dossier parent. S’il n’est pas spécifié ou null, le dossier est créé avec l’espace de travail en tant que dossier parent.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

Folder

Object

Objet folder.

Nom	Type	Description
displayName	string	Nom complet du dossier.
id	string (uuid)	ID du dossier.
parentFolderId	string (uuid)	ID du dossier parent. Si le dossier parent est un espace de travail, parentFolderId n’est pas spécifié ou null.
workspaceId	string (uuid)	Identifiant de l’espace de travail.