Git - List Workspace Relations

サービス:: Core

API バージョン:: v1

指定したワークスペースのワークスペース関係の一覧を返します。

Note

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

この API では、改ページ位置の修正がサポートされています。

Permissions

呼び出し元には、 ビューアー 以上のワークスペースロールが必要です。

必要な委任スコープ

Workspace.Read.All または Workspace.ReadWrite.All

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

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

Identity	Support
ユーザー	はい
サービスプリンシパルとマネージド ID	はい

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/workspaceRelations

省略可能なパラメーターを含む:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/workspaceRelations?continuationToken={continuationToken}

URI パラメーター

名前	/	必須	型	説明
workspaceId	path	True	string (uuid)	ワークスペース ID。
continuationToken	query		string	結果の次のページを取得するためのトークン。

応答

名前型説明

200 OK

名前	型	説明
200 OK	WorkspaceRelations	要求は正常に完了しました。
429 Too Many Requests	ErrorResponse	サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す `Retry-After` ヘッダーを返します。ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラーコード: InsufficientPrivileges - 呼び出し元に十分なワークスペースアクセス許可がありません。 WorkspaceNotFound - 指定されたワークスペースが見つかりませんでした。

WorkspaceRelations

要求は正常に完了しました。

429 Too Many Requests

ErrorResponse

サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer

Other Status Codes

ErrorResponse

一般的なエラーコード:

InsufficientPrivileges - 呼び出し元に十分なワークスペースアクセス許可がありません。
WorkspaceNotFound - 指定されたワークスペースが見つかりませんでした。

例

List workspace relations example

要求のサンプル

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/66666666-6666-6666-6666-666666666666/git/workspaceRelations

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "88888888-8888-8888-8888-888888888888",
      "relationType": "Base"
    },
    {
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "22222222-2222-2222-2222-222222222222",
      "relationType": "RelatedWorkspace"
    },
    {
      "id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "44444444-4444-4444-4444-444444444444",
      "relationType": "RelatedWorkspace"
    }
  ]
}

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
WorkspaceRelation	ワークスペース関係オブジェクト。
WorkspaceRelations	ワークスペースの関係の一覧。
WorkspaceRelationType	リレーションシップ内の関連するワークスペースの種類。関連するワークスペースの種類が時間の経過と同時に追加される場合があります。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable	boolean	true の場合、要求を再試行できます。 `Retry-After`応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message	string	エラーの人間が理解可能な表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が理解可能な表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

WorkspaceRelation

Object

ワークスペース関係オブジェクト。

名前	型	説明
id	string (uuid)	ワークスペースの関係 ID。
relatedWorkspaceId	string (uuid)	関連するワークスペース ID。
relationType	WorkspaceRelationType	リレーションシップ内の関連するワークスペースの種類。
workspaceId	string (uuid)	ワークスペース ID。

WorkspaceRelations

Object

ワークスペースの関係の一覧。

名前	型	説明
continuationToken	string	次の結果セットバッチのトークン。これ以上レコードがない場合は、応答から削除されます。
continuationUri	string	次の結果セットバッチの URI。これ以上レコードがない場合は、応答から削除されます。
value	WorkspaceRelation[]	ワークスペースの関係の一覧。

WorkspaceRelationType

列挙

リレーションシップ内の関連するワークスペースの種類。関連するワークスペースの種類が時間の経過と同時に追加される場合があります。

値	説明
Base	関連するワークスペースは、基本 (ソース) ワークスペースです。
Branch	関連するワークスペースはブランチワークスペースです。
RelatedWorkspace	関連するワークスペースには、一般的な関係があります。