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
api-version	query		string	Версия 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

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

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

AtlasEntitiesWithExtInfo

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

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

AtlasEntity

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

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

AtlasEntityHeader

Экземпляр сущности, например 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

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

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

AtlasTermAssignmentHeader

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

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

AtlasTermAssignmentStatus

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

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

BusinessAttributeUpdateBehavior

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

Имя	Тип	Описание
ignore	string	Игнорируйте полезные данные бизнес-атрибута для обновления.
merge	string	Объедините бизнес-атрибуты. Бизнес-атрибуты не обновляются, если они не указаны.
replace	string	Замените все бизнес-атрибуты с помощью полезных данных.

EntityMutationResult

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

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

EntityStatus

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

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

TimeBoundary

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

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