Del via

Folders - Create Folder

  • Reference
Tjeneste:
Core
API-version:
v1

Seddel

Denne API er en prøveversion.

Opretter en mappe i det angivne arbejdsområde.

Tilladelser

Den, der ringer op, skal have bidragyder eller en højere rolle i arbejdsområdet.

Påkrævede delegerede områder

Workspace.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet Support
Bruger Ja
tjenesteprincipal og administrerede identiteter Ja

Grænseflade

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

URI-parametre

Name I Påkrævet Type Beskrivelse
workspaceId
 path True

string (uuid)

Arbejdsområde-id'et.

Brødtekst for anmodning

Name Påkrævet Type Beskrivelse
displayName True

string

Det viste mappenavn. Navnet skal opfylde kravene til mappenavn
parentFolderId

string (uuid)

Det overordnede mappe-id. Hvis den ikke er angivet eller null, oprettes mappen med arbejdsområdet som den overordnede mappe.

Svar

Name Type Beskrivelse
201 Created

Folder

Oprettet
Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • FolderDisplayNameAlreadyInUse – Mappevisningsnavn bruges allerede.

  • FolderNotFound – Den ønskede mappe blev ikke fundet i arbejdsområdet.

  • InvalidFolderDisplayName – Det angivne viste mappenavn er ugyldigt.

  • FolderDepthOutOfRange – Den overordnede mappe har opnået maksimal dybde og kan ikke oprette en ny undermappe.

  • WorkspaceNotSupported – Den angivne arbejdsområdetype understøtter ikke mappe

.* TooManyFolders – Det angivne arbejdsområde har nået det maksimale antal mapper, og der kan ikke oprettes flere.

Eksempler

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

Eksempelanmodning

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

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

Eksempelsvar

Statuskode:
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

Eksempelanmodning

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

{
  "displayName": "A folder"
}

Eksempelsvar

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

Definitioner

Name Beskrivelse
CreateFolderRequest

Opret nyttedata for mappeanmodning.
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.
Folder

Et mappeobjekt.

CreateFolderRequest

Object

Opret nyttedata for mappeanmodning.

Name Type Beskrivelse
displayName

string

Det viste mappenavn. Navnet skal opfylde kravene til mappenavn
parentFolderId

string (uuid)

Det overordnede mappe-id. Hvis den ikke er angivet eller null, oprettes mappen med arbejdsområdet som den overordnede mappe.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

Folder

Object

Et mappeobjekt.

Name Type Beskrivelse
displayName

string

Det viste mappenavn.
id

string (uuid)

Mappe-id'et.
parentFolderId

string (uuid)

Det overordnede mappe-id. Hvis den overordnede mappe er et arbejdsområde, er parentFolderId enten ikke angivet eller null.
workspaceId

string (uuid)

Arbejdsområde-id'et.