Glossary - Partial Update

Ссылка

Служба:: Purview

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

Частично обновите глоссарий. Некоторые свойства, такие как qualifiedName, не допускаются к обновлению.

Пока мы поддерживают только частичное обновление shortDescription, longDescription, языка и использования для глоссария.

Рекомендуется использовать ignoreTermsAndCategories=true, чтобы уменьшить размер текста ответа.

PUT {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/partial

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

PUT {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/partial?api-version=2023-09-01&ignoreTermsAndCategories={ignoreTermsAndCategories}

Параметры URI

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

Ответы

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

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

HTTP

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

{
  "longDescription": "Example Long Description"
}

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

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

{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "lastModifiedTS": "3",
  "language": "en",
  "usage": "Example Glossary",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1672892675600,
  "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	active
DEPRECATED	string	deprecated
DRAFT	string	Проект
OBSOLETE	string	устарело
OTHER	string	иное

EntityStatus

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

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

TimeBoundary

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

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

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