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

Glossary - Get Detailed

  • Ссылка
Служба:
Purview
Версия API:
2023-09-01

Получите конкретный глоссарий с подробными сведениями. Этот API не рекомендуется.

Рекомендуется отдельно получить сведения о терминах и категориях с помощью

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms и

GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.

GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed
С использованием необязательных параметров: 
GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed?api-version=2023-09-01

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string

glossaryId
 path True

string

Глобальный уникальный идентификатор глоссария.
api-version
 query

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

AtlasGlossaryExtInfo

Запрос выполнен успешно.
Other Status Codes

AtlasErrorResponse

Непредвиденное сообщение об ошибке.

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

OAuth2Auth

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

Области

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

Примеры

Glossary_GetDetailed

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

GET {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/detailed?api-version=2023-09-01

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

Код состояния:
200 
{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "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",
      "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
    },
    {
      "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
    },
    {
      "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
    }
  ],
  "termInfo": {
    "54688d39-b298-4104-9e80-f2a16f44aaea": {
      "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
      "qualifiedName": "ExampleTerm1@Glossary",
      "name": "ExampleTerm1",
      "shortDescription": "Example Short Description",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "2",
      "abbreviation": "T1",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287247276,
      "updateTime": 1606290587593,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
      },
      "assignedEntities": [
        {
          "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
          "typeName": "hdfs_path",
          "entityStatus": "ACTIVE",
          "displayText": "1",
          "relationshipType": "AtlasGlossarySemanticAssignment",
          "relationshipGuid": "cf2e959c-05e6-4a9f-b106-b6475741c2ba",
          "relationshipStatus": "ACTIVE",
          "relationshipAttributes": {
            "typeName": "AtlasGlossarySemanticAssignment",
            "attributes": {
              "expression": "Example Expression",
              "createdBy": "ExampleCreator",
              "steward": "ExampleSteward",
              "confidence": 100,
              "description": "Example Description",
              "source": "Azure",
              "status": null
            }
          }
        }
      ],
      "categories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007"
        }
      ],
      "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"
        }
      ]
    },
    "952c7ba4-4c89-42d8-a05a-7d2161be7008": {
      "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "qualifiedName": "ExampleTerm2@Glossary",
      "name": "ExampleTerm2",
      "shortDescription": "Example Short Description",
      "lastModifiedTS": "1",
      "abbreviation": "T2",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287312495,
      "updateTime": 1606287312495,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189"
      },
      "seeAlso": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
          "displayText": "ExampleTerm1"
        }
      ],
      "synonyms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
          "displayText": "ExampleTerm1"
        }
      ],
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    }
  },
  "categoryInfo": {
    "ed7458f0-9463-48a5-b5c6-4f785fb34e12": {
      "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory1",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "3",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
      },
      "parentCategory": {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
      },
      "childrenCategories": [
        {
          "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
          "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
        }
      ],
      "terms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
          "displayText": "ExampleTerm1"
        }
      ]
    },
    "e47c4584-daca-4f9e-9092-194e04692c9a": {
      "guid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "qualifiedName": "ExampleCategory2@Glossary",
      "name": "ExampleCategory2",
      "lastModifiedTS": "1",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
      },
      "childrenCategories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
        }
      ]
    },
    "0d6766f6-f4b6-435b-bda2-d3edc358998e": {
      "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
      "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory3",
      "lastModifiedTS": "2",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
      },
      "parentCategory": {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
      }
    }
  }
}

Определения

Имя Описание
AtlasClassification

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

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

Категория глоссария.
AtlasGlossaryExtInfo

Расширенная информация глоссария.
AtlasGlossaryHeader

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

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

Заголовок связанной категории.
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

Идентификатор запроса.

AtlasGlossaryCategory

Категория глоссария.

Имя Тип Описание
anchor

AtlasGlossaryHeader

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

AtlasRelatedCategoryHeader[]

Массив дочерних категорий.
classifications

AtlasClassification[]

Массив классификаций.
createTime

integer

Время создания записи.
createdBy

string

Пользователь, создавший запись.
guid

string

GUID объекта .
lastModifiedTS

string

ETag для управления параллелизмом.
longDescription

string

Подробное описание версии.
name

string

Имя объекта глоссария.
parentCategory

AtlasRelatedCategoryHeader

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

string

Полное имя объекта глоссария.
shortDescription

string

Краткая версия описания.
terms

AtlasRelatedTermHeader[]

Массив связанных заголовков терминов.
updateTime

integer

Время обновления записи.
updatedBy

string

Пользователь, который обновил запись.

AtlasGlossaryExtInfo

Расширенная информация глоссария.

Имя Тип Описание
categories

AtlasRelatedCategoryHeader[]

Массив категорий.
categoryInfo

<string,  AtlasGlossaryCategory>

Сведения о категории глоссария.
classifications

AtlasClassification[]

Массив классификаций.
createTime

integer

Время создания записи.
createdBy

string

Пользователь, создавший запись.
guid

string

GUID объекта .
language

string

Язык глоссария.
lastModifiedTS

string

ETag для управления параллелизмом.
longDescription

string

Подробное описание версии.
name

string

Имя объекта глоссария.
qualifiedName

string

Полное имя объекта глоссария.
shortDescription

string

Краткая версия описания.
termInfo

<string,  AtlasGlossaryTerm>

Сведения о термине глоссария.
terms

AtlasRelatedTermHeader[]

Массив связанных заголовков терминов.
updateTime

integer

Время обновления записи.
updatedBy

string

Пользователь, который обновил запись.
usage

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[]

Массив связанных заголовков терминов в качестве допустимых значений для других записей.

AtlasRelatedCategoryHeader

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

Имя Тип Описание
categoryGuid

string

GUID категории.
description

string

Описание заголовка категории.
displayText

string

Отображаемый текст.
parentCategoryGuid

string

GUID родительской категории.
relationGuid

string

GUID связи.

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

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

Часовой пояс временной границы.