Freigeben über

Folders - Create Folder

Dienst:
Core
API-Version:
v1

Erstellt einen Ordner im angegebenen Arbeitsbereich.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Permissions

Der Anrufer muss Mitwirkender oder höherer Arbeitsbereichsrolle haben.

Erforderliche delegierte Bereiche

Workspace.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
User Yes
Service Principal und Verwaltete Identitäten Yes

Interface

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Name Erforderlich Typ Beschreibung
displayName True

string

Der Anzeigename des Ordners. Der Name muss Anforderungen für Ordnernamen erfüllen
parentFolderId

string (uuid)

Die id des übergeordneten Ordners. Wenn er nicht angegeben oder null ist, wird der Ordner mit dem Arbeitsbereich als übergeordneter Ordner erstellt.

Antworten

Name Typ Beschreibung
201 Created

Folder

Erfolgreich erstellt
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • FolderDisplayNameAlreadyInUse - Der Anzeigename des Ordners wird bereits verwendet.

  • FolderNotFound – Der angeforderte Ordner wurde im Arbeitsbereich nicht gefunden.

  • InvalidFolderDisplayName – Der angegebene Ordneranzeigename ist ungültig.

  • FolderDepthOutOfRange – Der übergeordnete Ordner hat die maximale Tiefe erreicht, kann keinen neuen Unterordner erstellen.

  • WorkspaceNotSupported – Der angegebene Arbeitsbereichstyp unterstützt Ordner nicht.

.* TooManyFolders – Der angegebene Arbeitsbereich hat die maximale Anzahl von Ordnern erreicht, kann nicht mehr erstellen.

Beispiele

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

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

{
  "displayName": "A folder"
}

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CreateFolderRequest

Erstellen sie die Nutzlast der Ordneranforderung.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
Folder

Ein Ordnerobjekt.

CreateFolderRequest

Objekt

Erstellen sie die Nutzlast der Ordneranforderung.

Name Typ Beschreibung
displayName

string

Der Anzeigename des Ordners. Der Name muss Anforderungen für Ordnernamen erfüllen
parentFolderId

string (uuid)

Die id des übergeordneten Ordners. Wenn er nicht angegeben oder null ist, wird der Ordner mit dem Arbeitsbereich als übergeordneter Ordner erstellt.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

Folder

Objekt

Ein Ordnerobjekt.

Name Typ Beschreibung
displayName

string

Der Anzeigename des Ordners.
id

string (uuid)

Die Ordner-ID.
parentFolderId

string (uuid)

Die id des übergeordneten Ordners. Wenn der übergeordnete Ordner ein Arbeitsbereich ist, wird parentFolderId entweder nicht angegeben oder null.
workspaceId

string (uuid)

Die Arbeitsbereichs-ID.