Relationship - Get

서비스:: Purview

API 버전:: 2023-09-01

GUID를 사용하여 엔터티 간의 관계 정보를 가져옵니다.

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}

선택적 매개 변수:

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}?extendedInfo={extendedInfo}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string (uri)
guid	path	True	string	관계의 전역적으로 고유한 식별자입니다.
extendedInfo	query		boolean	확장 정보가 포함되는지 여부를 제한합니다.

응답

Name	형식	Description
200 OK	AtlasRelationshipWithExtInfo	요청이 성공했습니다.
Other Status Codes	AtlasErrorResponse	예기치 않은 오류 응답입니다.

보안

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
https://purview.azure.net/.default

예제

Relationship_Get

샘플 요청

HTTP

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?extendedInfo=false

샘플 응답

상태 코드:: 200

{
  "relationship": {
    "typeName": "AtlasGlossarySynonym",
    "attributes": {
      "expression": null,
      "steward": null,
      "description": null,
      "source": null,
      "status": null
    },
    "guid": "de23cd5a-021c-413d-98a5-98752a1f7a3b",
    "end1": {
      "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
      "typeName": "AtlasGlossaryTerm"
    },
    "end2": {
      "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef",
      "typeName": "AtlasGlossaryTerm"
    },
    "label": "r:AtlasGlossarySynonym",
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1553838993803,
    "updateTime": 1553838993803,
    "version": 0
  }
}

정의

Name	Description
AtlasClassification	분류의 인스턴스입니다. ID가 없습니다. 이 개체는 엔터티와 연결된 경우에만 존재합니다.
AtlasEntityHeader	엔터티 인스턴스(예: hive_table, hive_database)
AtlasErrorResponse	서비스의 오류 응답
AtlasObjectId	엔터티와 같은 형식의 개체 인스턴스에 대한 참조입니다.
AtlasRelationship	Atlas 관계 인스턴스입니다.
AtlasRelationshipWithExtInfo	확장 정보와의 관계입니다.
AtlasTermAssignmentHeader	용어 할당의 헤더입니다.
AtlasTermAssignmentStatus	용어 할당 상태
EntityStatus	상태 - 활성 또는 삭제 가능
StatusAtlasRelationship	아틀라스 관계의 상태
TimeBoundary	시간 경계 세부 정보를 캡처합니다.

AtlasClassification

Object

분류의 인스턴스입니다. ID가 없습니다. 이 개체는 엔터티와 연결된 경우에만 존재합니다.

Name	형식	Description
attributes		구조체의 특성입니다.
entityGuid	string	엔터티의 GUID입니다.
entityStatus	EntityStatus	엔터티의 상태 - 활성 또는 삭제할 수 있습니다. 삭제된 엔터티는 제거되지 않습니다.
lastModifiedTS	string	동시성 제어를 위한 ETag입니다.
removePropagationsOnEntityDelete	boolean	엔터티 삭제 시 전파가 제거될지 여부를 결정합니다.
typeName	string	형식의 이름입니다.
validityPeriods	TimeBoundary[]	유효 기간을 나타내는 시간 경계의 배열입니다.

AtlasEntityHeader

Object

엔터티 인스턴스(예: hive_table, hive_database)

Name	형식	Description
attributes		구조체의 특성입니다.
classificationNames	string[]	분류 이름의 배열입니다.
classifications	AtlasClassification[]	분류의 배열입니다.
displayText	string	표시 텍스트입니다.
guid	string	레코드의 GUID입니다.
isIncomplete	boolean	셸 엔터티인지 여부
labels	string[]	레이블
lastModifiedTS	string	동시성 제어를 위한 ETag입니다.
meaningNames	string[]	의미의 배열입니다.
meanings	AtlasTermAssignmentHeader[]	용어 할당 헤더의 배열입니다.
status	EntityStatus	엔터티의 상태 - 활성 또는 삭제할 수 있습니다. 삭제된 엔터티는 제거되지 않습니다.
typeName	string	형식의 이름입니다.

AtlasErrorResponse

Object

서비스의 오류 응답

Name	형식	Description
errorCode	string	오류 코드입니다.
errorMessage	string	오류 메시지입니다.
requestId	string (uuid)	요청 ID입니다.

AtlasObjectId

Object

엔터티와 같은 형식의 개체 인스턴스에 대한 참조입니다.

Name	형식	Description
guid	string	개체의 GUID입니다.
typeName	string	형식의 이름입니다.
uniqueAttributes		개체의 고유 특성입니다.

AtlasRelationship

Object

Atlas 관계 인스턴스입니다.

Name	형식	Description
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)	관계의 버전입니다.

AtlasRelationshipWithExtInfo

Object

확장 정보와의 관계입니다.

Name	형식	Description
referredEntities	<string, AtlasEntityHeader>	참조된 엔터티 헤더입니다.
relationship	AtlasRelationship	Atlas 관계 인스턴스입니다.

AtlasTermAssignmentHeader

Object

용어 할당의 헤더입니다.

Name	형식	Description
confidence	integer (int32)	용어 할당의 신뢰도입니다.
createdBy	string	레코드를 만든 사용자입니다.
description	string	용어 할당에 대한 설명입니다.
displayText	string	표시 텍스트입니다.
expression	string	용어 할당의 식입니다.
relationGuid	string (uuid)	관계의 GUID입니다.
status	AtlasTermAssignmentStatus	조건 할당의 상태입니다.
steward	string	용어의 청지기입니다.
termGuid	string (uuid)	용어의 GUID입니다.

AtlasTermAssignmentStatus

열거형

용어 할당 상태

값	Description
DISCOVERED	상태가 검색됩니다.
PROPOSED	상태가 제안됩니다.
IMPORTED	상태를 가져옵니다.
VALIDATED	상태의 유효성이 검사됩니다.
DEPRECATED	상태는 더 이상 사용되지 않습니다.
OBSOLETE	상태가 사용되지 않습니다.
OTHER	기타 상태입니다.

EntityStatus

열거형

상태 - 활성 또는 삭제 가능

값	Description
ACTIVE	상태가 활성 상태입니다.
DELETED	상태가 삭제됩니다.

StatusAtlasRelationship

열거형

아틀라스 관계의 상태

값	Description
ACTIVE	활동적인
DELETED	deleted

TimeBoundary

Object

시간 경계 세부 정보를 캡처합니다.

Name	형식	Description
endTime	string	시간 경계의 끝입니다.
startTime	string	시간 경계의 시작입니다.
timeZone	string	시간 경계의 표준 시간대입니다.

다음을 통해 공유

Relationship - Get

URI 매개 변수

응답

보안

OAuth2Auth

범위

예제

Relationship_Get

샘플 요청

샘플 응답

정의

AtlasClassification

AtlasEntityHeader

AtlasErrorResponse

AtlasObjectId

AtlasRelationship

AtlasRelationshipWithExtInfo

AtlasTermAssignmentHeader

AtlasTermAssignmentStatus

EntityStatus

StatusAtlasRelationship

TimeBoundary