Поделиться через

Folders - Create Folder

Служба:
Core
Версия API:
v1

Создает папку в указанной рабочей области.

Note

Этот API является частью предварительного выпуска и предоставляется только для оценки и разработки. Он может измениться на основе отзывов и не рекомендуется для использования в рабочей среде.

Permissions

Вызывающий объект должен иметь участника или более поздней роли рабочей области.

Обязательные делегированные области

Workspace.ReadWrite.All

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Identity Support
User Yes
Представитель службы и управляемые удостоверения Yes

Interface

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

Параметры URI

Имя В Обязательно Тип Описание
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

Текст запроса

Имя Обязательно Тип Описание
displayName True

string

Отображаемое имя папки. Имя должно соответствовать требованиям к имени папки

parentFolderId

string (uuid)

Идентификатор родительской папки. Если не указано или значение NULL, папка создается в рабочей области в качестве родительской папки.

Ответы

Имя Тип Описание
201 Created

Folder

Успешно создано
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • FolderDisplayNameAlreadyInUse — отображаемое имя папки уже используется.

  • FolderNotFound — запрошенная папка не найдена в рабочей области.

  • InvalidFolderDisplayName — отображаемое имя предоставленной папки недопустимо.

  • FolderDepthOutOfRange — родительская папка достигла максимальной глубины, не может создать новую вложенную папку.

  • WorkspaceNotSupported — указанный тип рабочей области не поддерживает папку

.* TooManyFolders — указанная рабочая область достигла максимального количества папок, больше не может создаваться.

Примеры

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

Образец запроса

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

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

Пример ответа

Код состояния:
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

Образец запроса

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

{
  "displayName": "A folder"
}

Пример ответа

Код состояния:
201 
{
  "id": "eeeeeeee-4444-5555-6666-ffffffffffff",
  "displayName": "A folder",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
}

Определения

Имя Описание
CreateFolderRequest

Создайте полезные данные запроса к папке.
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
Folder

Объект папки.

CreateFolderRequest

Object

Создайте полезные данные запроса к папке.

Имя Тип Описание
displayName

string

Отображаемое имя папки. Имя должно соответствовать требованиям к имени папки

parentFolderId

string (uuid)

Идентификатор родительской папки. Если не указано или значение NULL, папка создается в рабочей области в качестве родительской папки.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

Folder

Object

Объект папки.

Имя Тип Описание
displayName

string

Отображаемое имя папки.
id

string (uuid)

Идентификатор папки.
parentFolderId

string (uuid)

Идентификатор родительской папки. Если родительская папка является рабочей областью, parentFolderId не указан или null.
workspaceId

string (uuid)

Идентификатор рабочей области.