Relationship - Get
Получение сведений о связях между сущностями по идентификатору GUID.
GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}
GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}?extendedInfo={extendedInfo}
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
guid
|
path | True |
string |
Глобальный уникальный идентификатор связи. |
extended
|
query |
boolean |
Ограничивает, включает ли расширенную информацию. |
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос выполнен успешно. |
|
Other Status Codes |
Непредвиденное сообщение об ошибке. |
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Имя | Описание |
---|---|
https://purview.azure.net/.default |
Образец запроса
GET {endpoint}/datamap/api/atlas/v2/relationship/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?extendedInfo=false
Пример ответа
{
"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
}
}
Имя | Описание |
---|---|
Atlas |
Экземпляр классификации; у него нет удостоверения, этот объект существует только в том случае, если он связан с сущностью. |
Atlas |
Экземпляр сущности, например hive_table, hive_database. |
Atlas |
Ответ об ошибке от службы |
Atlas |
Ссылка на экземпляр объекта типа , например сущность. |
Atlas |
Экземпляр связи Atlas. |
Atlas |
Связь с расширенными сведениями. |
Atlas |
Заголовок для назначения термина. |
Atlas |
Состояние назначения терминов |
Entity |
Состояние — может быть активным или удаленным |
Status |
Состояние связи atlas |
Time |
Фиксирует сведения о границах времени |
Экземпляр классификации; у него нет удостоверения, этот объект существует только в том случае, если он связан с сущностью.
Имя | Тип | Описание |
---|---|---|
attributes |
Атрибуты структуры. |
|
entityGuid |
string |
GUID сущности. |
entityStatus |
Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются. |
|
lastModifiedTS |
string |
ETag для управления параллелизмом. |
removePropagationsOnEntityDelete |
boolean |
Определяет, будет ли распространение удалено при удалении сущности. |
typeName |
string |
Имя типа. |
validityPeriods |
Массив временных границ, указывающих срок действия. |
Экземпляр сущности, например hive_table, hive_database.
Имя | Тип | Описание |
---|---|---|
attributes |
Атрибуты структуры. |
|
classificationNames |
string[] |
Массив имен классификации. |
classifications |
Массив классификаций. |
|
displayText |
string |
Отображаемый текст. |
guid |
string |
GUID записи. |
isIncomplete |
boolean |
Является ли это сущностью оболочки |
labels |
string[] |
метки; |
lastModifiedTS |
string |
ETag для управления параллелизмом. |
meaningNames |
string[] |
Массив значений. |
meanings |
Массив заголовков назначений терминов. |
|
status |
Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются. |
|
typeName |
string |
Имя типа. |
Ответ об ошибке от службы
Имя | Тип | Описание |
---|---|---|
errorCode |
string |
Код ошибки. |
errorMessage |
string |
Сообщение об ошибке. |
requestId |
string |
Идентификатор запроса. |
Ссылка на экземпляр объекта типа , например сущность.
Имя | Тип | Описание |
---|---|---|
guid |
string |
GUID объекта . |
typeName |
string |
Имя типа. |
uniqueAttributes |
Уникальные атрибуты объекта . |
Экземпляр связи Atlas.
Имя | Тип | Описание |
---|---|---|
attributes |
Атрибуты структуры. |
|
createTime |
integer |
Время создания записи. |
createdBy |
string |
Пользователь, создавший запись. |
end1 |
Ссылка на экземпляр объекта типа , например сущность. |
|
end2 |
Ссылка на экземпляр объекта типа , например сущность. |
|
guid |
string |
GUID связи. |
homeId |
string |
Идентификатор домашней страницы связи. |
label |
string |
Метка связи. |
lastModifiedTS |
string |
ETag для управления параллелизмом. |
provenanceType |
integer |
Используется для записи происхождения экземпляра сущности или связи |
status |
Перечисление состояния связи. |
|
typeName |
string |
Имя типа. |
updateTime |
integer |
Время обновления записи. |
updatedBy |
string |
Пользователь, который обновил запись. |
version |
integer |
Версия связи. |
Связь с расширенными сведениями.
Имя | Тип | Описание |
---|---|---|
referredEntities |
<string,
Atlas |
Заголовок упоминаемой сущности. |
relationship |
Экземпляр связи Atlas. |
Заголовок для назначения термина.
Имя | Тип | Описание |
---|---|---|
confidence |
integer |
Достоверность назначения термина. |
createdBy |
string |
Пользователь, создавший запись. |
description |
string |
Описание назначения термина. |
displayText |
string |
Отображаемый текст. |
expression |
string |
Выражение назначения термина. |
relationGuid |
string |
GUID связи. |
status |
Состояние назначения терминов. |
|
steward |
string |
Стюард термина. |
termGuid |
string |
GUID термина. |
Состояние назначения терминов
Имя | Тип | Описание |
---|---|---|
DEPRECATED |
string |
Состояние является нерекомендуемой. |
DISCOVERED |
string |
Состояние обнаружено. |
IMPORTED |
string |
Состояние импортировано. |
OBSOLETE |
string |
Состояние устарело. |
OTHER |
string |
Другое состояние. |
PROPOSED |
string |
Предлагается состояние . |
VALIDATED |
string |
Состояние проверяется. |
Состояние — может быть активным или удаленным
Имя | Тип | Описание |
---|---|---|
ACTIVE |
string |
Состояние активно. |
DELETED |
string |
Состояние удалено. |
Состояние связи atlas
Имя | Тип | Описание |
---|---|---|
ACTIVE |
string |
active |
DELETED |
string |
deleted |
Фиксирует сведения о границах времени
Имя | Тип | Описание |
---|---|---|
endTime |
string |
Конец границы времени. |
startTime |
string |
Начало границы времени. |
timeZone |
string |
Часовой пояс границы времени. |