Relationship - Create

リファレンス

サービス:: Purview

API バージョン:: 2023-09-01

エンティティ間に新しいリレーションシップを作成します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string

要求本文

名前	型	説明
attributes		構造体の属性。
createTime	integer	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
end1	AtlasObjectId	エンティティなど、型のオブジェクトインスタンスへの参照。
end2	AtlasObjectId	エンティティなど、型のオブジェクトインスタンスへの参照。
guid	string	リレーションシップの GUID。
homeId	string	リレーションシップのホーム ID。
label	string	リレーションシップのラベル。
lastModifiedTS	string	コンカレンシー制御の ETag。
provenanceType	integer	エンティティまたはリレーションシップのインスタンスの証明を記録するために使用されます
status	StatusAtlasRelationship	リレーションシップの状態の列挙型。
typeName	string	型の名前。
updateTime	integer	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer	リレーションシップのバージョン。

応答

名前	型	説明
200 OK	AtlasRelationship	要求は成功しました。
Other Status Codes	AtlasErrorResponse	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://purview.azure.net/.default

例

Relationship_Create

要求のサンプル

HTTP

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
}

定義

名前	説明
AtlasErrorResponse	サービスからのエラー応答
AtlasObjectId	エンティティなど、型のオブジェクトインスタンスへの参照。
AtlasRelationship	Atlas リレーションシップインスタンス。
StatusAtlasRelationship	Atlas リレーションシップの状態

AtlasErrorResponse

サービスからのエラー応答

名前	型	説明
errorCode	string	エラーコード。
errorMessage	string	エラーメッセージ。
requestId	string	要求 ID です。

AtlasObjectId

エンティティなど、型のオブジェクトインスタンスへの参照。

名前	型	説明
guid	string	オブジェクトの GUID。
typeName	string	型の名前。
uniqueAttributes		オブジェクトの一意の属性。

AtlasRelationship

Atlas リレーションシップインスタンス。

名前	型	説明
attributes		構造体の属性。
createTime	integer	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
end1	AtlasObjectId	エンティティなど、型のオブジェクトインスタンスへの参照。
end2	AtlasObjectId	エンティティなど、型のオブジェクトインスタンスへの参照。
guid	string	リレーションシップの GUID。
homeId	string	リレーションシップのホーム ID。
label	string	リレーションシップのラベル。
lastModifiedTS	string	コンカレンシー制御の ETag。
provenanceType	integer	エンティティまたはリレーションシップのインスタンスの証明を記録するために使用されます
status	StatusAtlasRelationship	リレーションシップの状態の列挙型。
typeName	string	型の名前。
updateTime	integer	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer	リレーションシップのバージョン。

StatusAtlasRelationship

Atlas リレーションシップの状態

名前	型	説明
ACTIVE	string	active
DELETED	string	deleted

次の方法で共有