Udostępnij przez

Folders - Update Folder

Usługa:
Core
Wersja interfejsu API:
v1

Aktualizuje właściwości określonego folderu.

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 wyższą w obszarze roboczym.

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

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
folderId
 path True

string (uuid)

Identyfikator folderu.
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

Odpowiedzi

Nazwa Typ Opis
200 OK

Folder

Żądanie zostało ukończone pomyślnie.
Other Status Codes

ErrorResponse

Typowe kody błędów:

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

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

  • InvalidFolderDisplayName — podana nazwa folderu jest nieprawidłowa, taka jak dołączenie nieprawidłowych znaków.

Przykłady

Update a folder example

Przykładowe żądanie

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

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "id": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb",
  "displayName": "A new Folder name",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
}

Definicje

Nazwa Opis
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.
UpdateFolderRequest

Zaktualizuj żądanie folderu.

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.

UpdateFolderRequest

Objekt

Zaktualizuj żądanie folderu.

Nazwa Typ Opis
displayName

string

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