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

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)
guid	path	True	string	Глобальный уникальный идентификатор связи.
extendedInfo	query		boolean	Ограничивает наличие расширенных сведений.

Ответы

Имя	Тип	Описание
200 OK	AtlasRelationshipWithExtInfo	Запрос выполнен успешно.
Other Status Codes	AtlasErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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
  }
}

Определения

Имя	Описание
AtlasClassification	Экземпляр классификации; Он не имеет удостоверения, этот объект существует только при сопоставлении с сущностью.
AtlasEntityHeader	Экземпляр сущности, например hive_table, hive_database.
AtlasErrorResponse	Ответ об ошибке службы
AtlasObjectId	Ссылка на экземпляр объекта типа, например сущность.
AtlasRelationship	Экземпляр связи Atlas.
AtlasRelationshipWithExtInfo	Связь с расширенными сведениями.
AtlasTermAssignmentHeader	Заголовок для назначения терминов.
AtlasTermAssignmentStatus	Состояние назначения терминов
EntityStatus	Состояние — может быть активным или удаленным
StatusAtlasRelationship	Состояние связи atlas
TimeBoundary	Записывает сведения о границах времени

AtlasClassification

Object

Экземпляр классификации; Он не имеет удостоверения, этот объект существует только при сопоставлении с сущностью.

Имя	Тип	Описание
attributes		Атрибуты структуры.
entityGuid	string	GUID сущности.
entityStatus	EntityStatus	Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются.
lastModifiedTS	string	ETag для элемента управления параллелизмом.
removePropagationsOnEntityDelete	boolean	Определяет, будут ли распространения удалены при удалении сущностей.
typeName	string	Имя типа.
validityPeriods	TimeBoundary[]	Массив границ времени, указывающий срок действия.

AtlasEntityHeader

Object

Экземпляр сущности, например hive_table, hive_database.

Имя	Тип	Описание
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

Ответ об ошибке службы

Имя	Тип	Описание
errorCode	string	Код ошибки.
errorMessage	string	Сообщение об ошибке.
requestId	string (uuid)	Идентификатор запроса.

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	Идентификатор домашней связи.
label	string	Метка связи.
lastModifiedTS	string	ETag для элемента управления параллелизмом.
provenanceType	integer (int32)	Используется для записи происхождения экземпляра сущности или связи
status	StatusAtlasRelationship	Перечисление состояния связи.
typeName	string	Имя типа.
updateTime	integer (int64)	Время обновления записи.
updatedBy	string	Пользователь, который обновил запись.
version	integer (int64)	Версия связи.

AtlasRelationshipWithExtInfo

Object

Связь с расширенными сведениями.

Имя	Тип	Описание
referredEntities	<string, AtlasEntityHeader>	Заголовок указанной сущности.
relationship	AtlasRelationship	Экземпляр связи Atlas.

AtlasTermAssignmentHeader

Object

Заголовок для назначения терминов.

Имя	Тип	Описание
confidence	integer (int32)	Достоверность назначения термина.
createdBy	string	Пользователь, создавший запись.
description	string	Описание назначения термина.
displayText	string	Отображаемый текст.
expression	string	Выражение назначения термина.
relationGuid	string (uuid)	GUID связи.
status	AtlasTermAssignmentStatus	Состояние назначения терминов.
steward	string	Стюард термина.
termGuid	string (uuid)	GUID термина.

AtlasTermAssignmentStatus

Перечисление

Состояние назначения терминов

Значение	Описание
DEPRECATED	Состояние устарело.
DISCOVERED	Состояние обнаруживается.
IMPORTED	Состояние импортируется.
OBSOLETE	Состояние устарело.
OTHER	Другое состояние.
PROPOSED	Предлагается состояние.
VALIDATED	Состояние проверяется.

EntityStatus

Перечисление

Состояние — может быть активным или удаленным

Значение	Описание
ACTIVE	Состояние активно.
DELETED	Состояние удаляется.

StatusAtlasRelationship

Перечисление

Состояние связи atlas

Значение	Описание
ACTIVE	активный
DELETED	deleted

TimeBoundary

Object

Записывает сведения о границах времени

Имя	Тип	Описание
endTime	string	Окончание границы времени.
startTime	string	Начало границы времени.
timeZone	string	Часовой пояс границы времени.

Поделиться через

Relationship - Get

Параметры URI

Ответы

Безопасность

OAuth2Auth

Области

Примеры

Relationship_Get

Образец запроса

Пример ответа

Определения

AtlasClassification

AtlasEntityHeader

AtlasErrorResponse

AtlasObjectId

AtlasRelationship

AtlasRelationshipWithExtInfo

AtlasTermAssignmentHeader

AtlasTermAssignmentStatus

EntityStatus

StatusAtlasRelationship

TimeBoundary