Git - List Workspace Relations

服務:
Core
API 版本:
v1

回傳指定工作區的相關關係清單。

Note

此 API 是預覽版的一部分，僅供評估和開發之用。 它可能會根據意見反應而變更，不建議用於生產環境。

此 API 支援 分頁。

許可

來電者必須擁有 瀏覽器 或更高階的工作區角色。

必要的委派範圍

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支援的身份識別

此 API 支援本節中列出的Microsoft 身分識別。

Identity Support
User 是的
服務主體 和 受控識別 是的

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 參數

名稱 位於 必要 類型 Description
workspaceId
 path True

string (uuid)

工作區識別碼。
continuationToken
 query

string

用來擷取下一頁結果的令牌。

回覆

名稱 類型 Description
200 OK

WorkspaceRelations

要求成功完成。
429 Too Many Requests

ErrorResponse

服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。

標題

Retry-After: integer
Other Status Codes

ErrorResponse

常見的錯誤碼：

  • InsufficientPrivileges - 呼叫端沒有足夠的工作區許可權。

  • WorkspaceNotFound - 指定的工作空間未被找到。

範例

List workspace relations example

範例要求

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"
    }
  ]
}

定義

名稱 Description
ErrorParameter

一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource

錯誤相關的資源詳細資料物件。
ErrorResponse

錯誤回應。
ErrorResponseDetails

錯誤回應的細節。
WorkspaceRelation

一個工作空間關係物件。
WorkspaceRelations

一份工作空間關係列表。
WorkspaceRelationType

關聯中相關工作空間的類型。 隨著時間推移，可能會新增更多相關的工作區類型。

ErrorParameter

Object

一個結構化參數，提供關於錯誤的額外機器可讀上下文。

名稱 類型 Description
message

string

一個人類可讀的參數意義描述。
name

string

參數識別碼。
value

string

這是參數值。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。
resourceType

string

發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
isRetriable

boolean

若屬實，請求可重新嘗試。 如果有延遲，請使用 Retry-After 回應標頭來判斷延遲。
message

string

以人類可讀格式呈現的錯誤訊息。
moreDetails

ErrorResponseDetails[]

其他錯誤詳情的清單。
parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。
relatedResource

ErrorRelatedResource

與錯誤相關的資源詳情。
requestId

string (uuid)

與錯誤相關聯的要求識別碼。

ErrorResponseDetails

Object

錯誤回應的細節。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

以人類可讀格式呈現的錯誤訊息。
parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。
relatedResource

ErrorRelatedResource

與錯誤相關的資源詳情。

WorkspaceRelation

Object

一個工作空間關係物件。

名稱 類型 Description
id

string (uuid)

工作區關係 ID。
relatedWorkspaceId

string (uuid)

相關的工作區 ID。
relationType

WorkspaceRelationType

關聯中相關工作空間的類型。
workspaceId

string (uuid)

工作區識別碼。

WorkspaceRelations

Object

一份工作空間關係列表。

名稱 類型 Description
continuationToken

string

下一個結果集批次的令牌。 如果沒有其他記錄，則會從回應中移除。
continuationUri

string

下一個結果集批次的 URI。 如果沒有其他記錄，則會從回應中移除。
value

WorkspaceRelation[]

一份工作空間關係列表。

WorkspaceRelationType

列舉型別

關聯中相關工作空間的類型。 隨著時間推移，可能會新增更多相關的工作區類型。

值 Description
Base

相關的工作區是基礎（來源）工作區。
Branch

相關的工作區是分支工作區。
RelatedWorkspace

相關的工作空間有一般的關聯。