Partager via

Folders - Update Folder

Service:
Core
Version d'API:
v1

Met à jour les propriétés du dossier 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 un rôle contributeur ou supérieur sur l’espace de travail.

É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

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

Paramètres URI

Nom Dans Obligatoire Type Description
folderId
 path True

string (uuid)

ID du dossier.
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

Réponses

Nom Type Description
200 OK

Folder

La demande s’est terminée avec succès.
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • FolderNotFound : le dossier demandé n’a pas été trouvé dans l’espace de travail.

  • FolderDisplayNameAlreadyInUse : le nom d’affichage du dossier est déjà utilisé.

  • InvalidFolderDisplayName : le nom de dossier fourni n’est pas valide, comme l’inclusion de caractères non valides.

Exemples

Update a folder example

Exemple de requête

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

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

Exemple de réponse

Code d’état:
200 
{
  "id": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb",
  "displayName": "A new Folder name",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
}

Définitions

Nom Description
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.
UpdateFolderRequest

Mettre à jour la demande de dossier.

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.

UpdateFolderRequest

Object

Mettre à jour la demande de dossier.

Nom Type Description
displayName

string

Nom complet du dossier. Le nom doit respecter conditions requises pour le nom du dossier