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

Folders - Update Folder

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

Обновляет свойства указанной папки.

Note

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

Permissions

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

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

Workspace.ReadWrite.All

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

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

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

Interface

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

Параметры URI

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

string (uuid)

Идентификатор папки.
workspaceId
 path True

string (uuid)

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

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

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

string

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

Ответы

Имя Тип Описание
200 OK

Folder

Запрос успешно завершен.
Other Status Codes

ErrorResponse

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

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

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

  • InvalidFolderDisplayName — предоставленное имя папки является недопустимым, например включение недопустимых символов.

Примеры

Update a folder example

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

PATCH https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/folders/aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb

{
  "displayName": "A new Folder name"
}

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

Код состояния:
200 
{
  "id": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb",
  "displayName": "A new Folder name",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
}

Определения

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

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

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

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

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

Обновление запроса папки.

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)

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

UpdateFolderRequest

Object

Обновление запроса папки.

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

string

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