Glossary - Partial Update Term

Ссылка

Служба:: Purview

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

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

PUT {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}/partial

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

PUT {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}/partial?api-version=2023-09-01&includeTermHierarchy={includeTermHierarchy}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)
termId	path	True	string	Глобальный уникальный идентификатор термина глоссария.
api-version	query		string minLength: 1	Версия API, используемая для этой операции.
includeTermHierarchy	query		boolean	Включение иерархии терминов

Ответы

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

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

HTTP

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

{
  "longDescription": "Example Long Description"
}

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

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

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Descrition",
  "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"
  },
  "categories": [
    {
      "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
      "displayText": "ExampleCategory1"
    }
  ],
  "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"
    }
  ],
  "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

Object

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

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

AtlasErrorResponse

Object

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

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

AtlasGlossaryHeader

Object

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

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

AtlasGlossaryTerm

Object

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

Имя	Тип	Описание
abbreviation	string	Сокращение термина.
anchor	AtlasGlossaryHeader	Заголовок глоссария с основными сведениями.
antonyms	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов в виде антонимов.
assignedEntities	AtlasRelatedObjectId[]	Массив идентификаторов связанных объектов.
attributes	object	Настраиваемые атрибуты термина, который является сопоставлением<строк,map<string,object>>. Ключом карты первого слоя является имя шаблона термина.
categories	AtlasTermCategorizationHeader[]	Массив заголовков классификации терминов.
classifications	AtlasClassification[]	Массив классификаций.
classifies	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов.
contacts	object	Словарь контактов для терминов. Ключ может быть экспертом или стюардом.
createTime	integer (int64)	Время создания записи.
createdBy	string	Пользователь, создавший запись.
examples	string[]	Массив примеров.
guid	string	GUID объекта.
hierarchyInfo	PurviewObjectId[]	Сведения о иерархии термина.
isA	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов, указывающих на связь " — это связь".
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 (int64)	Время обновления записи.
updatedBy	string	Пользователь, который обновил запись.
usage	string	Использование термина.
validValues	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов в качестве допустимых значений.
validValuesFor	AtlasRelatedTermHeader[]	Массив связанных заголовков терминов в качестве допустимых значений для других записей.

AtlasRelatedObjectId

Object

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

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

AtlasRelatedTermHeader

Object

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

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

AtlasStruct

Object

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

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

AtlasTermCategorizationHeader

Object

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

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

AtlasTermRelationshipStatus

Перечисление

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

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

EntityStatus

Перечисление

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

Значение	Описание
ACTIVE	Состояние активно.
DELETED	Состояние удаляется.

PurviewObjectId

Object

PurviewObjectId

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

ResourceLink

Object

ResourceLink

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

StatusAtlasRelationship

Перечисление

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

Значение	Описание
ACTIVE	активный
DELETED	deleted

TermStatus

Перечисление

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

Значение	Описание
Alert	предупреждение
Approved	одобренный
Draft	черновик
Expired	Истек

TimeBoundary

Object

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

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

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

Glossary - Partial Update Term

Параметры URI

Ответы

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

OAuth2Auth

Области

Примеры

Glossary_PartialUpdateTerm

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

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

Определения

AtlasClassification

AtlasErrorResponse

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary

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