Folders - Create Folder

Tjänst:: Core

API-version:: v1

Skapar en mapp på den angivna arbetsytan.

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 deltagare eller högre arbetsyteroll.

Obligatoriska delegerade omfång

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

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string (uuid)	Arbetsmiljöns ID.

Begärandetext

Name	Obligatorisk	Typ	Description
displayName	True	string	Mappens visningsnamn. Namnet måste uppfylla kraven för mappnamn
parentFolderId		string (uuid)	Det överordnade mapp-ID:t. Om den inte anges eller är null skapas mappen med arbetsytan som överordnad mapp.

Svar

Name Typ Description

201 Created

Name	Typ	Description
201 Created	Folder	Har skapats
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: FolderDisplayNameAlreadyInUse – Mappvisningsnamn används redan. FolderNotFound – Den begärda mappen hittades inte på arbetsytan. InvalidFolderDisplayName – det angivna mappvisningsnamnet är ogiltigt. FolderDepthOutOfRange – Den överordnade mappen har uppnått maximalt djup, kan inte skapa en ny undermapp. WorkspaceNotSupported – den angivna arbetsytetypen stöder inte mapp .* TooManyFolders – Den angivna arbetsytan har nått maximalt antal mappar, kan inte skapa fler.

Folder

Har skapats

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:

FolderDisplayNameAlreadyInUse – Mappvisningsnamn används redan.
FolderNotFound – Den begärda mappen hittades inte på arbetsytan.
InvalidFolderDisplayName – det angivna mappvisningsnamnet är ogiltigt.
FolderDepthOutOfRange – Den överordnade mappen har uppnått maximalt djup, kan inte skapa en ny undermapp.
WorkspaceNotSupported – den angivna arbetsytetypen stöder inte mapp

.* TooManyFolders – Den angivna arbetsytan har nått maximalt antal mappar, kan inte skapa fler.

Exempel

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

Exempelbegäran

HTTP

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

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

Exempelsvar

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

Exempelbegäran

HTTP

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

{
  "displayName": "A folder"
}

Exempelsvar

Statuskod:: 201

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

Definitioner

Name	Description
CreateFolderRequest	Skapa nyttolast för mappbegäran.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
Folder	Ett mappobjekt.

CreateFolderRequest

Objekt

Skapa nyttolast för mappbegäran.

Name	Typ	Description
displayName	string	Mappens visningsnamn. Namnet måste uppfylla kraven för mappnamn
parentFolderId	string (uuid)	Det överordnade mapp-ID:t. Om den inte anges eller är null skapas mappen med arbetsytan som överordnad mapp.

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.