Entity - Bulk Create Or Update

Ссылка

Служба:: Purview

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

Создание или обновление сущностей в массовом режиме. Существующая сущность сопоставляется с помощью уникального guid, если он предоставлен или по уникальным атрибутам, например: qualifiedName. Сопоставление и массив коллекций не поддерживаются. Например, массив<массив>,<<строке сопоставления массива, int>>. Для каждого типа контакта максимальное число контактов — 20.

POST {endpoint}/datamap/api/atlas/v2/entity/bulk

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

POST {endpoint}/datamap/api/atlas/v2/entity/bulk?api-version=2023-09-01&collectionId={collectionId}&businessAttributeUpdateBehavior={businessAttributeUpdateBehavior}

Параметры URI

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

Текст запроса

Имя	Тип	Описание
entities	AtlasEntity[]	Массив сущностей.
referredEntities	<string, AtlasEntity>	Указанные сущности.

Ответы

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

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

OAuth2Auth

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

Области

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

Примеры

Entity_BulkCreateOrUpdate

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

HTTP

POST {endpoint}/datamap/api/atlas/v2/entity/bulk?api-version=2023-09-01

{
  "referredEntities": {},
  "entities": [
    {
      "typeName": "azure_storage_account",
      "attributes": {
        "owner": "ExampleOwner",
        "modifiedTime": 0,
        "createTime": 0,
        "qualifiedName": "exampleaccount1",
        "name": "ExampleStorageAccount1",
        "description": null,
        "publicAccessLevel": null
      },
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Owner": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Owner Info"
          }
        ]
      },
      "status": "ACTIVE",
      "createdBy": "ExampleCreator",
      "updatedBy": "ExampleUpdator",
      "version": 0
    },
    {
      "typeName": "azure_storage_account",
      "attributes": {
        "owner": "ExampleOwner",
        "modifiedTime": 0,
        "createTime": 0,
        "qualifiedName": "exampleaccount2",
        "name": "ExampleStorageAccount2",
        "description": "Example Description",
        "publicAccessLevel": null
      },
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Owner": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Owner Info"
          }
        ]
      },
      "status": "ACTIVE",
      "createdBy": "ExampleCreator",
      "updatedBy": "ExampleUpdator",
      "version": 0
    }
  ]
}

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

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

{
  "mutatedEntities": {
    "UPDATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount2"
        },
        "lastModifiedTS": "2",
        "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1",
        "status": "ACTIVE"
      }
    ],
    "CREATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount1"
        },
        "lastModifiedTS": "1",
        "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
        "status": "ACTIVE"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
    "-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
  }
}

Определения

Имя	Описание
AtlasClassification	Экземпляр классификации; Он не имеет удостоверения, этот объект существует только при сопоставлении с сущностью.
AtlasEntitiesWithExtInfo	Экземпляр сущности вместе с расширенными сведениями, например hive_table, hive_database.
AtlasEntity	Экземпляр сущности, например hive_table, hive_database.
AtlasEntityHeader	Экземпляр сущности, например hive_table, hive_database.
AtlasErrorResponse	Ответ об ошибке службы
AtlasTermAssignmentHeader	Заголовок для назначения терминов.
AtlasTermAssignmentStatus	Состояние назначения терминов
BusinessAttributeUpdateBehavior	Используется для определения поведения обновления для бизнес-атрибутов при обновлении сущностей.
EntityMutationResult	Результат отклика мутации сущности.
EntityStatus	Состояние — может быть активным или удаленным
TimeBoundary	Записывает сведения о границах времени

AtlasClassification

Object

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

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

AtlasEntitiesWithExtInfo

Object

Экземпляр сущности вместе с расширенными сведениями, например hive_table, hive_database.

Имя	Тип	Описание
entities	AtlasEntity[]	Массив сущностей.
referredEntities	<string, AtlasEntity>	Указанные сущности.

AtlasEntity

Object

Экземпляр сущности, например hive_table, hive_database.

Имя	Тип	Описание
attributes		Атрибуты структуры.
businessAttributes		Бизнес-атрибуты
classifications	AtlasClassification[]	Массив классификаций.
collectionId	string	Идентификатор коллекции сущности.
contacts	object	Словарь контактов для сущностей. Ключ может быть экспертом или владельцем.
createTime	integer (int64)	Время создания записи.
createdBy	string	Пользователь, создавший запись.
customAttributes	object	Настраиваемый атрибут
guid	string	GUID сущности.
homeId	string	Идентификатор домашней сущности.
isIncomplete	boolean	Является ли она сущностью оболочки
labels	string[]	Метки
lastModifiedTS	string	ETag для элемента управления параллелизмом.
meanings	AtlasTermAssignmentHeader[]	Массив заголовков назначения терминов, указывающих значения сущности.
provenanceType	integer (int32)	Используется для записи происхождения экземпляра сущности или связи.
proxy	boolean	Определяет, есть ли прокси-сервер.
relationshipAttributes		Атрибуты связи.
status	EntityStatus	Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются.
typeName	string	Имя типа.
updateTime	integer (int64)	Время обновления записи.
updatedBy	string	Пользователь, который обновил запись.
version	integer (int64)	Версия сущности.

AtlasEntityHeader

Object

Экземпляр сущности, например hive_table, hive_database.

Имя	Тип	Описание
attributes		Атрибуты структуры.
classificationNames	string[]	Массив имен классификации.
classifications	AtlasClassification[]	Массив классификаций.
displayText	string	Отображаемый текст.
guid	string	GUID записи.
isIncomplete	boolean	Является ли она сущностью оболочки
labels	string[]	Метки
lastModifiedTS	string	ETag для элемента управления параллелизмом.
meaningNames	string[]	Массив значений.
meanings	AtlasTermAssignmentHeader[]	Массив заголовков назначения терминов.
status	EntityStatus	Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются.
typeName	string	Имя типа.

AtlasErrorResponse

Object

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

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

AtlasTermAssignmentHeader

Object

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

Имя	Тип	Описание
confidence	integer (int32)	Достоверность назначения термина.
createdBy	string	Пользователь, создавший запись.
description	string	Описание назначения термина.
displayText	string	Отображаемый текст.
expression	string	Выражение назначения термина.
relationGuid	string (uuid)	GUID связи.
status	AtlasTermAssignmentStatus	Состояние назначения терминов.
steward	string	Стюард термина.
termGuid	string (uuid)	GUID термина.

AtlasTermAssignmentStatus

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

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

Значение	Описание
DEPRECATED	Состояние устарело.
DISCOVERED	Состояние обнаруживается.
IMPORTED	Состояние импортируется.
OBSOLETE	Состояние устарело.
OTHER	Другое состояние.
PROPOSED	Предлагается состояние.
VALIDATED	Состояние проверяется.

BusinessAttributeUpdateBehavior

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

Используется для определения поведения обновления для бизнес-атрибутов при обновлении сущностей.

Значение	Описание
ignore	Игнорировать полезные данные бизнес-атрибута для обновления.
merge	Слияние бизнес-атрибутов. Бизнес-атрибуты не будут обновляться, если они не предоставлены.
replace	Замените все бизнес-атрибуты полезными данными.

EntityMutationResult

Object

Результат отклика мутации сущности.

Имя	Тип	Описание
guidAssignments	object	Карта назначений GUID с сущностями.
mutatedEntities	object	Заголовки сущностей мутируемых сущностей.
partialUpdatedEntities	AtlasEntityHeader[]	Массив заголовков сущностей, которые частично обновлены.

EntityStatus

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

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

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

TimeBoundary

Object

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

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