Folders - Get Folder

Service:
Core
API-versie:
v1

Retourneert de eigenschappen van de opgegeven map.

Note

Deze API maakt deel uit van een preview-versie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik.

Permissions

De beller moet een viewer of een hogere rol hebben in de werkruimte.

Vereiste gedelegeerde bereiken

Workspace.Read.All of Workspace.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identity Support
User Yes
serviceprincipal en beheerde identiteiten Yes

Interface

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

URI-parameters

Naam In Vereist Type Description
folderId
 path True

string (uuid)

De map-id.
workspaceId
 path True

string (uuid)

De werkruimte-id.

Antwoorden

Naam Type Description
200 OK

Folder

De aanvraag is voltooid.
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • FolderNotFound : de aangevraagde map is niet gevonden in de werkruimte.

Voorbeelden

Get a folder example

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Naam Description
ErrorParameter

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
Folder

Een mapobject.

ErrorParameter

Object

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.

Naam Type Description
message

string

Een door mensen leesbare beschrijving van de betekenis van de parameter.
name

string

De parameter-id.
value

string

De waarde van de parameter.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Naam Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Naam Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
parameters

ErrorParameter[]

Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Naam Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
parameters

ErrorParameter[]

Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

Folder

Object

Een mapobject.

Naam Type Description
displayName

string

De weergavenaam van de map.
id

string (uuid)

De map-id.
parentFolderId

string (uuid)

De id van de bovenliggende map. Als de bovenliggende map een werkruimte is, is parentFolderId niet opgegeven of null.
workspaceId

string (uuid)

De werkruimte-id.