Glossary - List

Ссылка

Служба:: Purview

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

Получите все глоссарии. Рекомендуется использовать ограничение или смещение, чтобы получить результат разбивки на страницы. Рекомендуется использовать "ignoreTermsAndCategories=true" и получить термины/категории отдельно с помощью get /datamap/api/atlas/v2/глоссарий/{глоссарий/{глоссарий}/термины" и "GET "/datamap/api/atlas/v2/глоссарий/{глоссарий}/категории".

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

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

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit={limit}&offset={offset}&sort={sort}&ignoreTermsAndCategories={ignoreTermsAndCategories}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string
api-version	query		string	Версия API, используемая для этой операции.
ignoreTermsAndCategories	query		boolean	Следует ли игнорировать термины и категории
limit	query		integer int32	Размер страницы — по умолчанию нет разбиения по страницам.
offset	query		integer int32	Смещение для назначения разбиения на страницы.
sort	query		string	Порядок сортировки, ASC (по умолчанию) или DESC.

Ответы

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

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

OAuth2Auth

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

Области

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

Примеры

Glossary_List

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

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit=1&offset=0&sort=ASC

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

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

[
  {
    "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "qualifiedName": "Glossary",
    "name": "Glossary",
    "shortDescription": "Example Short Description",
    "longDescription": "Example Long Description",
    "lastModifiedTS": "1",
    "language": "en",
    "usage": "Example Glossary",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1672892675688,
    "updateTime": 1672892675688,
    "terms": [
      {
        "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0",
        "displayText": "ExampleTerm1"
      },
      {
        "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
        "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189",
        "displayText": "ExampleTerm2"
      }
    ],
    "categories": [
      {
        "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
        "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2",
        "displayText": "ExampleCategory3"
      },
      {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0",
        "displayText": "ExampleCategory1"
      },
      {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d",
        "displayText": "ExampleCategory2"
      }
    ]
  }
]

Определения

Имя	Описание
AtlasClassification	Экземпляр классификации; Он не имеет удостоверения, этот объект существует только при сопоставлении с сущностью.
AtlasErrorResponse	Ответ об ошибке службы
AtlasGlossary	Глоссарийный объект.
AtlasRelatedCategoryHeader	Заголовок связанной категории.
AtlasRelatedTermHeader	Заголовок связанного термина.
AtlasTermRelationshipStatus	Состояние связи терминов atlas
EntityStatus	Состояние — может быть активным или удаленным
TimeBoundary	Записывает сведения о границах времени

AtlasClassification

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

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

AtlasErrorResponse

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

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

AtlasGlossary

Глоссарийный объект.

Имя	Тип	Описание
categories	AtlasRelatedCategoryHeader[]	Массив категорий.
classifications	AtlasClassification[]	Массив классификаций.
createTime	integer	Время создания записи.
createdBy	string	Пользователь, создавший запись.
guid	string	GUID объекта.
language	string	Язык глоссария.
lastModifiedTS	string	ETag для элемента управления параллелизмом.
longDescription	string	Описание длинной версии.
name	string	Имя объекта глоссария.
qualifiedName	string	Полное имя объекта глоссария.
shortDescription	string	Короткая версия описания.
terms	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов.
updateTime	integer	Время обновления записи.
updatedBy	string	Пользователь, который обновил запись.
usage	string	Использование глоссария.

AtlasRelatedCategoryHeader

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

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

AtlasRelatedTermHeader

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

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

AtlasTermRelationshipStatus

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

Имя	Тип	Описание
ACTIVE	string	активный
DEPRECATED	string	Устаревшие
DRAFT	string	черновик
OBSOLETE	string	устаревший
OTHER	string	другой

EntityStatus

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

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

TimeBoundary

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

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

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