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

title: "Действие" summary: | /api/action методы. redirect_from: - /ru/docs/latest/api/action

Действие

/api/action/ методы.

DELETE /api/action/:action-id

Удалить действие.

ПАРАМЕТРЫ:

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

Удалить общедоступную ссылку на этот дашборд.

ПАРАМЕТРЫ:

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

GET /api/action/

Возвращает действия, которые могут использоваться для QueryActions. По умолчанию выводит все доступные для просмотра действия. Передайте необязательный параметр ?model-id=<model-id> для ограничения действий определённой модели.

ПАРАМЕТРЫ:

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

GET /api/action/:action-id

Получить действие.

ПАРАМЕТРЫ:

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

GET /api/action/:action-id/execute

Получает значения для заполнения параметров выполнения. Передайте параметры первичного ключа и значения для выбора.

ПАРАМЕТРЫ:

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

  • parameters действительная JSON-строка.

GET /api/action/public

Получить список действий с общедоступными UUID. Эти действия общедоступны если включен общедоступный доступ.

POST /api/action/

Создает новое Действие.

ПАРАМЕТРЫ:

  • visualization_settings карта значений или null.

  • parameters последовательность карт значений или null.

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

  • error_handle null или стро — действительный json-query, например, '.item.title'

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

  • name строка.

  • response_handle null или стро — действительный json-query, например, '.item.title'

  • template строка, где {:method -> , :url -> = 1>, :body (optional) -> , :headers (optional) -> , :parameters (optional) -> , :parameter_mappings (optional) -> }. Других ключей быть не должно.

  • type в настоящее время не поддерживается.

  • dataset_query карта значений или null.

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

  • kind может быть пустым или не пустым, не поддерживается в текущей реализации.

  • parameter_mappings карта значений или null.

  • action

POST /api/action/:id/execute

Выполнить Действие.

parameters должны быть параметрами, сопоставленные с дашбордом, и имеющими заданные значения.

ПАРАМЕТРЫ:

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

  • parameters карта значений от до или null.

  • _body

POST /api/action/:id/public_link

Генерирует общедоступные ссылки для этого Действия. Возвращает UUID для использования в общедоступных ссылках. (Если это Действие уже было опубликовано, оно вернёт существующую общедоступную ссылку вместо создания новой). Общедоступный обмен должен быть включен.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

ПАРАМЕТРЫ:

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

PUT /api/action/:id

Обновить действие.

ПАРАМЕТРЫ:

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

  • type В настоящее время поддерживаются только HTTP-действия.

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

  • template null или карта со схемой: ( body (необязательно) : null или строка; headers (необязательно) : null или строка; parameter_mappings (необязательно) : null или карта; parameters (необязательно) : null или массив, каждый элемент которого является картой; method : значение должно быть одним из: DELETE, GET, PATCH, POST, PUT; url : строка. )

  • response_handle корректный json-query или null.

  • error_handle корректный json-query или null.

  • action Карта значений, где {

    :archived (optional) -> <логическое значение или null>, :database_id (optional) -> <целое число больше нуля или null>, :dataset_query (optional) -> <карта или null>, :description (optional) -> <строка или null>, :error_handle (optional) -> , :kind (optional) -> <неподдерживаемый тип неявного действия или null>, :model_id (optional) -> <целое число больше нуля или null>, :name (optional) -> <строка или null>, :parameter_mappings (optional) -> <карта или null>, :parameters (optional) -> <последовательность карт или null>, :response_handle (optional) -> , :template (optional) -> , :url -> <строка длиной не менее 1 символа>, :body (optional) -> <строка или null>, :headers (optional) -> <строка или null>, :parameters (optional) -> <последовательность карт или null>, :parameter_mappings (optional) -> <карта или null> } без каких-либо дополнительных ключей>, :type (optional) -> <неподдерживаемый тип действия или null>, :visualization_settings (optional) -> <карта или null> }