共用方式為

Relationship - Create

服務:
Purview
API 版本:
2023-09-01

建立實體之間的新關聯性。

POST {endpoint}/datamap/api/atlas/v2/relationship

URI 參數

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

string (uri)

要求本文

名稱 類型 Description
attributes

結構的屬性。
createTime

integer (int64)

記錄的建立時間。
createdBy

string

建立記錄的使用者。
end1

AtlasObjectId

型別的物件實例參考 - 例如實體。
end2

AtlasObjectId

型別的物件實例參考 - 例如實體。
guid

string

關聯性的 GUID。
homeId

string

關聯性的主標識碼。
label

string

關聯性的標籤。
lastModifiedTS

string

用於並行控制的 ETag。
provenanceType

integer (int32)

用來記錄實體或關聯性實例的證明
status

StatusAtlasRelationship

關聯性狀態的列舉。
typeName

string

型別的名稱。
updateTime

integer (int64)

記錄的更新時間。
updatedBy

string

更新記錄的使用者。
version

integer (int64)

關聯性的版本。

回應

名稱 類型 Description
200 OK

AtlasRelationship

要求已成功。
Other Status Codes

AtlasErrorResponse

未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
https://purview.azure.net/.default

範例

Relationship_Create

範例要求

POST {endpoint}/datamap/api/atlas/v2/relationship

{
  "typeName": "AtlasGlossarySynonym",
  "attributes": {
    "expression": "Example Expression",
    "steward": "Example Steward",
    "description": "Example Description",
    "source": null,
    "status": null
  },
  "end1": {
    "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
    "typeName": "AtlasGlossaryTerm"
  },
  "end2": {
    "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa",
    "typeName": "AtlasGlossaryTerm"
  },
  "label": "r:AtlasGlossarySynonym",
  "status": "ACTIVE",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "version": 0
}

範例回覆

狀態碼:
200 
{
  "typeName": "AtlasGlossarySynonym",
  "attributes": {
    "expression": "Example Expression",
    "steward": "Example Steward",
    "description": "Example Description",
    "source": null,
    "status": null
  },
  "guid": "63023d5b-c499-4360-a513-16bcbf73b039",
  "end1": {
    "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
    "typeName": "AtlasGlossaryTerm"
  },
  "end2": {
    "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa",
    "typeName": "AtlasGlossaryTerm"
  },
  "label": "r:AtlasGlossarySynonym",
  "status": "ACTIVE",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553840134724,
  "updateTime": 1553840134724,
  "version": 0
}

定義

名稱 Description
AtlasErrorResponse

來自服務的錯誤回應
AtlasObjectId

型別的物件實例參考 - 例如實體。
AtlasRelationship

Atlas 關聯性實例。
StatusAtlasRelationship

atlas 關聯性的狀態

AtlasErrorResponse

Object

來自服務的錯誤回應

名稱 類型 Description
errorCode

string

錯誤碼。
errorMessage

string

錯誤訊息。
requestId

string (uuid)

要求標識碼。

AtlasObjectId

Object

型別的物件實例參考 - 例如實體。

名稱 類型 Description
guid

string

物件的 GUID。
typeName

string

型別的名稱。
uniqueAttributes

物件的唯一屬性。

AtlasRelationship

Object

Atlas 關聯性實例。

名稱 類型 Description
attributes

結構的屬性。
createTime

integer (int64)

記錄的建立時間。
createdBy

string

建立記錄的使用者。
end1

AtlasObjectId

型別的物件實例參考 - 例如實體。
end2

AtlasObjectId

型別的物件實例參考 - 例如實體。
guid

string

關聯性的 GUID。
homeId

string

關聯性的主標識碼。
label

string

關聯性的標籤。
lastModifiedTS

string

用於並行控制的 ETag。
provenanceType

integer (int32)

用來記錄實體或關聯性實例的證明
status

StatusAtlasRelationship

關聯性狀態的列舉。
typeName

string

型別的名稱。
updateTime

integer (int64)

記錄的更新時間。
updatedBy

string

更新記錄的使用者。
version

integer (int64)

關聯性的版本。

StatusAtlasRelationship

列舉型別

atlas 關聯性的狀態

值 Description
ACTIVE

活動中
DELETED

已刪除