Перейти к содержанию

title: "Уведомления" summary: | /api/notify/* методы, которые получают входящие уведомления от etl-сервера. redirect_from: - /ru/docs/latest/api/notify

Уведомления

/api/notify/* методы, которые получают входящие уведомления от etl-сервера.

POST /api/notify/db/:id

Уведомление о потенциальном изменении схемы в одной из Databases. Вызывающий может дополнительно указать :table_id или :table_name в теле, чтобы ограничить обновления одной Table. Необязательный параметр :scan может быть "full" или "schema" для полной синхронизации или синхронизации схемы, доступен независимо от того, передается ли :table_id или :table_name. Этот метод защищен API ключом, который необходимо передать как заголовок X-METABASE-APIKEY, который необходимо определить в переменной среды MB_API_KEY environment variable.

Параметры:

  • id целое число больше нуля.

  • table_id целое число больше нуля или null.

  • table_name непустая строка или null.

  • scan null или перечисление full, schema.

  • synchronous?

POST /api/notify/db/:id/new-table

Синхронизирует новую таблицу без запуска полной синхронизации базы данных. Требуется schema_name и table_name. Будет сгенерирована ошибка, если таблица уже существует в GlarusBI или не может быть найдена.

PARAMS:

  • id целое число больше нуля.

  • schema_name непустая строка.

  • table_name непустая строка.

POST /api/notify/db/attached_datawarehouse

Синхронизировать подключенный хранилище данных. Можно предоставить в теле:

  • table_name и schema_name: обе строки. Будет искать существующую таблицу и синхронизировать её, иначе попытается найти новую таблицу с таким именем и синхронизировать её. Если не может найти таблицу, выдаст ошибку. Если table_name пустой или пустой, синхронизирует всю базу данных.
  • synchronous?: логическое значение, указывающее, должно ли это блокировать результат.

PARAMS:

  • table_name непустая строка или null.

  • schema_name строка или null.

  • synchronous? null или допустимая логическая строка ('true' или 'false').

<< Назад к разделу API