Folders - Get Folder

Tjänst:: Core

API-version:: v1

Returnerar egenskaperna för den angivna mappen.

Note

Det här API:et är en del av en förhandsversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning.

Permissions

Anroparen måste ha en visningsroll eller en högre roll på arbetsytan.

Obligatoriska delegerade omfång

Workspace.Read.All eller Workspace.ReadWrite.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Interface

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
folderId	path	True	string (uuid)	Mapp-ID:t.
workspaceId	path	True	string (uuid)	Arbetsmiljöns ID.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	Folder	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: FolderNotFound – Den begärda mappen hittades inte på arbetsytan.

Folder

Begäran har slutförts.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

FolderNotFound – Den begärda mappen hittades inte på arbetsytan.

Exempel

Get a folder example

Exempelbegäran

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders/bbbbbbbb-1111-2222-3333-cccccccccccc

Exempelsvar

Statuskod:: 200

{
  "id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
  "displayName": "A nested folder",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "parentFolderId": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb"
}

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
Folder	Ett mappobjekt.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

Folder

Objekt

Ett mappobjekt.

Name	Typ	Description
displayName	string	Mappens visningsnamn.
id	string (uuid)	Mapp-ID:t.
parentFolderId	string (uuid)	Det överordnade mapp-ID:t. Om den överordnade mappen är en arbetsyta `parentFolderId` inte har angetts eller null.
workspaceId	string (uuid)	Arbetsmiljöns ID.