Folders - Update Folder

Servizio:

Core

Versione API:

v1

Aggiorna le proprietà della cartella specificata.

Note

Questa API fa parte di una versione di anteprima e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione.

Permissions

Il chiamante deve avere un ruolo di collaboratore o superiore nell'area di lavoro.

Ambiti delegati obbligatori

Workspace.ReadWrite.All

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identity	Support
User	Yes
Principale del servizio e Identità gestite	Yes

Interface

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
folderId	path	True	string (uuid)	ID cartella.
workspaceId	path	True	string (uuid)	ID dell'area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
displayName	True	string	Nome visualizzato della cartella. Il nome deve soddisfare i requisiti Nome cartella

Risposte

Nome	Tipo	Descrizione
200 OK	Folder	Richiesta completata correttamente.
Other Status Codes	ErrorResponse	Codici di errore comuni: FolderNotFound: la cartella richiesta non è stata trovata nell'area di lavoro. FolderDisplayNameAlreadyInUse - Nome visualizzato cartella già usato. InvalidFolderDisplayName: il nome della cartella specificato non è valido, ad esempio inclusi caratteri non validi.

Esempio

Update a folder example

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
Folder	Oggetto cartella.
UpdateFolderRequest	Aggiornare la richiesta di cartella.

ErrorRelatedResource

Object

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Object

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

Folder

Object

Oggetto cartella.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato della cartella.
id	string (uuid)	ID cartella.
parentFolderId	string (uuid)	ID cartella padre. Se la cartella padre è un'area di lavoro, parentFolderId non è specificato o null.
workspaceId	string (uuid)	ID dell'area di lavoro.

UpdateFolderRequest

Object

Aggiornare la richiesta di cartella.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato della cartella. Il nome deve soddisfare i requisiti Nome cartella