Relationship - Update

サービス:

Purview

API バージョン:

2023-09-01

エンティティ間の既存のリレーションシップを更新します。

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

URI パラメーター

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

要求本文

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

応答

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

要求のサンプル

HTTP

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

{
  "typeName": "AtlasGlossarySynonym",
  "attributes": {
    "expression": "Example Expression",
    "steward": "Example Steward",
    "description": "Example Description",
    "source": null,
    "status": null
  },
  "guid": "b2810301-293f-493f-88f1-7ac8784fb1fd",
  "end1": {
    "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa",
    "typeName": "AtlasGlossaryTerm"
  },
  "end2": {
    "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef",
    "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": "b2810301-293f-493f-88f1-7ac8784fb1fd",
  "end1": {
    "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa",
    "typeName": "AtlasGlossaryTerm"
  },
  "end2": {
    "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef",
    "typeName": "AtlasGlossaryTerm"
  },
  "label": "r:AtlasGlossarySynonym",
  "status": "ACTIVE",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553839805039,
  "updateTime": 1553839805039,
  "version": 0
}

定義

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

AtlasErrorResponse

Object

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

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

AtlasObjectId

Object

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

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

AtlasRelationship

Object

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

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

StatusAtlasRelationship

列挙

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

値	説明
ACTIVE	活動中
DELETED	deleted