Udostępnij przez

Folders - Create Folder

Usługa:
Core
Wersja interfejsu API:
v1

Tworzy folder w określonym obszarze roboczym.

Note

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego.

Permissions

Obiekt wywołujący musi mieć rolę współautora lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

Workspace.ReadWrite.All

Tożsamości obsługiwane przez firmę Microsoft

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interface

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Identyfikator obszaru roboczego.

Treść żądania

Nazwa Wymagane Typ Opis
displayName True

string

Nazwa wyświetlana folderu. Nazwa musi spełniać wymagania dotyczące nazwy folderu

parentFolderId

string (uuid)

Identyfikator folderu nadrzędnego. Jeśli nie zostanie określony lub ma wartość null, folder zostanie utworzony z obszarem roboczym jako folderem nadrzędnym.

Odpowiedzi

Nazwa Typ Opis
201 Created

Folder

Pomyślnie utworzono
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • FolderDisplayNameAlreadyInUse — nazwa wyświetlana folderu jest już używana.

  • FolderNotFound — żądany folder nie został znaleziony w obszarze roboczym.

  • InvalidFolderDisplayName — podana nazwa wyświetlana folderu jest nieprawidłowa.

  • FolderDepthOutOfRange — folder nadrzędny osiągnął maksymalną głębokość, nie może utworzyć nowego podfolderu.

  • WorkspaceNotSupported — określony typ obszaru roboczego nie obsługuje folderu

.* TooManyFolders — określony obszar roboczy osiągnął maksymalną liczbę folderów, nie można utworzyć więcej.

Przykłady

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

Przykładowe żądanie

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

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

{
  "displayName": "A folder"
}

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
CreateFolderRequest

Utwórz ładunek żądania folderu.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
Folder

Obiekt folderu.

CreateFolderRequest

Objekt

Utwórz ładunek żądania folderu.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana folderu. Nazwa musi spełniać wymagania dotyczące nazwy folderu

parentFolderId

string (uuid)

Identyfikator folderu nadrzędnego. Jeśli nie zostanie określony lub ma wartość null, folder zostanie utworzony z obszarem roboczym jako folderem nadrzędnym.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

Folder

Objekt

Obiekt folderu.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana folderu.
id

string (uuid)

Identyfikator folderu.
parentFolderId

string (uuid)

Identyfikator folderu nadrzędnego. Jeśli folder nadrzędny jest obszarem roboczym, parentFolderId nie jest określony lub ma wartość null.
workspaceId

string (uuid)

Identyfikator obszaru roboczego.