次の方法で共有

Folders - Update Folder

サービス:
Core
API バージョン:
v1

指定したフォルダーのプロパティを更新します。

Note

この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。

Permissions

呼び出し元には、ワークスペースに 対する共同作成者 以上のロールが必要です。

必要な委任されたスコープ

Workspace.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

Identity Support
User Yes
サービス プリンシパルとマネージド ID Yes

Interface

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

URI パラメーター

名前 / 必須 型 説明
folderId
 path True

string (uuid)

フォルダー ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。

要求本文

名前 必須 型 説明
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

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。
requestId

string

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

Folder

Object

フォルダー オブジェクト。

名前 型 説明
displayName

string

フォルダーの表示名。
id

string (uuid)

フォルダー ID。
parentFolderId

string (uuid)

親フォルダー ID。 親フォルダーがワークスペースの場合、parentFolderId は指定されていないか null になります。
workspaceId

string (uuid)

ワークスペース ID。

UpdateFolderRequest

Object

フォルダーの更新要求。

名前 型 説明
displayName

string

フォルダーの表示名。 名前はフォルダー名の要件 満たしている必要があります