Glossary - Get Term

Ссылка

Служба:: Purview

Версия API:: 2023-09-01

Получение определенного термина глоссария по его GUID.

GET {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}

С использованием необязательных параметров:

GET {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}?api-version=2023-09-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string
termId	path	True	string	Глобальный уникальный идентификатор термина глоссария.
api-version	query		string	Версия API, используемая для данной операции.

Ответы

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

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

OAuth2Auth

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

Области

Имя	Описание
https://purview.azure.net/.default

Примеры

Glossary_GetTerm

Glossary_GetTermWithoutAssets

Glossary_GetTerm

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

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/term/54688d39-b298-4104-9e80-f2a16f44aaea?api-version=2023-09-01

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

Код состояния:: 200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
      "displayText": "ExampleTerm2"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
      "displayText": "ExampleTerm2"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "assignedEntities": [
    {
      "guid": "7e255139-b654-4c8d-a4bd-fbb5a243e83f",
      "typeName": "azure_datalake_gen2_path",
      "entityStatus": "ACTIVE",
      "displayText": "moviesDB.csv",
      "relationshipType": "AtlasGlossarySemanticAssignment",
      "relationshipGuid": "ace36560-6259-4e7f-9214-3850b2af0a86",
      "relationshipStatus": "ACTIVE",
      "relationshipAttributes": {
        "typeName": "AtlasGlossarySemanticAssignment",
        "attributes": {
          "expression": null,
          "createdBy": null,
          "steward": null,
          "confidence": null,
          "description": null,
          "source": null,
          "status": null
        }
      }
    }
  ]
}

Glossary_GetTermWithoutAssets

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

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/term/54688d39-b298-4104-9e80-f2a16f44aaea?api-version=2023-09-01

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

Код состояния:: 200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
      "displayText": "ExampleTerm2"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
      "displayText": "ExampleTerm2"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ]
}

Определения

Имя	Описание
AtlasClassification	Экземпляр классификации; у него нет удостоверения, этот объект существует только в том случае, если он связан с сущностью.
AtlasErrorResponse	Ответ об ошибке от службы
AtlasGlossaryHeader	Заголовок глоссария с основными сведениями.
AtlasGlossaryTerm	Термин глоссария.
AtlasRelatedObjectId	Ссылка на экземпляр объекта типа AtlasEntity, используемого в значениях атрибута связи
AtlasRelatedTermHeader	Заголовок связанного термина.
AtlasStruct	Записывает сведения о содержимом структуры. Экземпляр не создается напрямую, используется только через AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader	Основные сведения для классификации терминов.
AtlasTermRelationshipStatus	Состояние связи терминов atlas
EntityStatus	Состояние — может быть активным или удаленным
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	Состояние связи atlas
TermStatus	Состояние для термина
TimeBoundary	Фиксирует сведения о границах времени

AtlasClassification

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

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

AtlasErrorResponse

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

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

AtlasGlossaryHeader

Заголовок глоссария с основными сведениями.

Имя	Тип	Описание
displayText	string	Отображаемый текст.
glossaryGuid	string	GUID глоссария.
relationGuid	string	GUID связи.

AtlasGlossaryTerm

Термин глоссария.

Имя	Тип	Описание
abbreviation	string	Аббревиатура термина.
anchor	AtlasGlossaryHeader	Заголовок глоссария с основными сведениями.
antonyms	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов в виде антонимов.
assignedEntities	AtlasRelatedObjectId[]	Массив связанных идентификаторов объектов.
attributes	object	Настраиваемые атрибуты термина, который является строкой карты<, строкой карты<, объектом>>. Ключом карты первого слоя является имя шаблона термина.
categories	AtlasTermCategorizationHeader[]	Массив заголовков категоризации терминов.
classifications	AtlasClassification[]	Массив классификаций.
classifies	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов.
contacts	object	Словарь контактов для терминов. Ключом может быть эксперт или стюард.
createTime	integer	Время создания записи.
createdBy	string	Пользователь, создавший запись.
examples	string[]	Массив примеров.
guid	string	GUID объекта .
hierarchyInfo	PurviewObjectId[]	Сведения об иерархии термина.
isA	AtlasRelatedTermHeader[]	Массив заголовков связанных терминов, указывающих связь is-a.
lastModifiedTS	string	ETag для управления параллелизмом.
longDescription	string	Подробное описание версии.
name	string	Имя объекта глоссария.
nickName	string	Название термина.
preferredTerms	AtlasRelatedTermHeader[]	Массив предпочтительных связанных заголовков терминов.
preferredToTerms	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов, которые предпочтительнее.
qualifiedName	string	Полное имя объекта глоссария.
replacedBy	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов, которые заменяются .
replacementTerms	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов для замены.
resources	ResourceLink[]	Массив ссылки на ресурс для термина
seeAlso	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов для см. также.
shortDescription	string	Краткая версия описания.
status	TermStatus	Состояние AtlasGlossaryTerm
synonyms	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов в качестве синонимов.
templateName	TemplateName[]	Имя шаблона.
translatedTerms	AtlasRelatedTermHeader[]	Массив переведенных связанных заголовков терминов.
translationTerms	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов для перевода.
updateTime	integer	Время обновления записи.
updatedBy	string	Пользователь, который обновил запись.
usage	string	Использование термина .
validValues	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов в качестве допустимых значений.
validValuesFor	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов в качестве допустимых значений для других записей.

AtlasRelatedObjectId

Ссылка на экземпляр объекта типа AtlasEntity, используемого в значениях атрибута связи

Имя	Тип	Описание
displayText	string	Отображаемый текст.
entityStatus	EntityStatus	Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются.
guid	string	GUID объекта .
relationshipAttributes	AtlasStruct	Записывает сведения о содержимом структуры. Экземпляр не создается напрямую, используется только через AtlasEntity, AtlasClassification.
relationshipGuid	string	GUID связи.
relationshipStatus	StatusAtlasRelationship	Перечисление состояния связи.
relationshipType	string	Тип отношений
typeName	string	Имя типа.
uniqueAttributes		Уникальные атрибуты объекта .

AtlasRelatedTermHeader

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

Имя	Тип	Описание
description	string	Описание связанного термина.
displayText	string	Отображаемый текст.
expression	string	Выражение термина .
relationGuid	string	GUID связи.
status	AtlasTermRelationshipStatus	Состояние связи терминов.
steward	string	Стюард термина.
termGuid	string	GUID термина.

AtlasStruct

Записывает сведения о содержимом структуры. Экземпляр не создается напрямую, используется только через AtlasEntity, AtlasClassification.

Имя	Тип	Описание
attributes		Атрибуты структуры.
lastModifiedTS	string	ETag для управления параллелизмом.
typeName	string	Имя типа.

AtlasTermCategorizationHeader

Основные сведения для классификации терминов.

Имя	Тип	Описание
categoryGuid	string	GUID категории.
description	string	Описание записи.
displayText	string	Отображаемый текст.
relationGuid	string	GUID связи.
status	AtlasTermRelationshipStatus	Состояние связи терминов.

AtlasTermRelationshipStatus

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

Имя	Тип	Описание
ACTIVE	string	active
DEPRECATED	string	deprecated
DRAFT	string	Проект
OBSOLETE	string	устарело
OTHER	string	иное

EntityStatus

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

Имя	Тип	Описание
ACTIVE	string	Состояние активно.
DELETED	string	Состояние удалено.

PurviewObjectId

Имя	Тип	Описание
displayText	string	Отображаемый текст
guid	string	GUID объекта .
itemPath	string	Путь к элементу
name	string	Имя
properties		Словарь
resourceId	string	Идентификатор ресурса
typeName	string	Имя типа.
uniqueAttributes		Уникальные атрибуты объекта .

ResourceLink

Имя	Тип	Описание
displayName	string	Отображаемое имя для URL-адреса.
url	string	url-адрес веб-сайта. HTTP или HTTPS

StatusAtlasRelationship

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

Имя	Тип	Описание
ACTIVE	string	active
DELETED	string	deleted

TermStatus

Состояние для термина

Имя	Тип	Описание
Alert	string	предупреждение
Approved	string	Утвержденных
Draft	string	Проект
Expired	string	Истек

TimeBoundary

Фиксирует сведения о границах времени

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

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

Glossary - Get Term

Параметры URI

Ответы

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

OAuth2Auth

Области

Примеры

Glossary_GetTerm

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

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

Glossary_GetTermWithoutAssets

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

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

Определения

AtlasClassification

AtlasErrorResponse

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary

Дополнительные ресурсы