Пульс

/api/pulse методы.

DELETE /api/pulse/:id/subscription

Отписка пользователей от подписки на пульс.

Параметры:

  • id

GET /api/pulse/

Получить все подписки на дашборды. По умолчанию возвращает только подписки, для которых текущий пользователь имеет права на запись. Для администраторов это все подписки; для не-администраторов это только подписки, которые они создали.

Если dashboard_id указан, ограничивает результаты подпиской, связанной с данным дашбордом.

Если created_or_receive равно true возвращает все подписки, которые создал текущий пользователь или для которых он является получателем. Обратите внимание, что это надмножество по умолчанию возвращаемых элементов для не-администраторов и подмножество по умолчанию возвращаемых элементов для администраторов. Это используется для работы страницы /account/notifications. Это может включать подписки, для которых у текущего пользователя нет разрешений, в этом случае некоторая конфиденциальная метаинформация (список карт и получателей) удаляется. +

Параметры:

  • archived значение может быть пустым, или если не пустое, значение должно быть допустимой логической строкой (”true” или “false”).

  • dashboard_id значение может быть пустым, или если не пустое, значение должно быть целым числом больше нуля.

  • creator_or_recipient значение может быть пустым, или если не пустое, значение должно быть логическая строка (’true’ or ‘false’).

GET /api/pulse/:id

Получить пульс Pulse с ID. Если пользователь - получатель Пульса, но не имеет прав на чтение его коллекции, мы все равно возвращаем его, но с некоторой удаленной конфиденциальной метаинформацией.

Параметры:

  • id

GET /api/pulse/form_input

Предоставляет соответствующую информацию о конфигурации и настройки пользователя для создания/обновления Пульсов.

GET /api/pulse/preview_card/:id

Получить HTML интерпретацию Карточки с id.

Параметры:

  • id

GET /api/pulse/preview_card_info/:id

Получить объект JSON, содержащий HTML-рендеринг Карточки с id и другой информацией.

Параметры:

  • id

GET /api/pulse/preview_card_png/:id

Получить PNG изображение Карточки с id.

Параметры:

  • id

POST /api/pulse/

Создать новый Pulse.

Параметры:

  • name значение должно быть не пустой строкой.

  • cards значение должно быть массивом. Каждое значение должно удовлетворять одному из двух критериев: 1) значение должно быть картой со следующими ключами (collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings) 2) Значение должно быть картой со следующими ключами id, include_csv, include_xls, и dashboard_card_id. Массив не должен быть пустым.

  • channels значение должно быть массивом. Каждое значение должно быть картой. Массив не должен быть пустым.

  • skip_if_empty значение может быть пустым, или если не пустое, значение должно быть логическим.

  • collection_id значение может быть пустым, или если не пустое, значение должно быть целым числом больше нуля.

  • collection_position значение может быть пустым, или если не пустое, значение должно быть целым числом больше нуля.

  • dashboard_id значение может быть пустым, или если не пустое, значение должно быть целым числом больше нуля.

  • parameters значение должно быть массивом. Каждое значение должно быть картой.

POST /api/pulse/test

Тестовая отправка несохраненного Пульса.

Параметры:

  • name значение должно быть не пустой строкой.

  • cards значение должно быть массивом. Каждое значение должно отвечать одному из следующих требований: 1) значение должно быть картой со следующими ключами (collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings) 2) значение должно быть картой с ключами id, include_csv, include_xls, и dashboard_card_id. Массив не должен быть пустым.

  • channels значение должно быть массивом. Каждое значение должно быть картой. Массив не должен быть пустым.

  • skip_if_empty значение может быть пустым, или если не пустое, значение должно быть логическим.

  • collection_id значение может быть пустым, или если не пустое, значение должно быть целым числом больше нуля.

  • collection_position значение может быть пустым, или если не пустое, значение должно быть целым числом больше нуля.

  • dashboard_id значение может быть пустым, или если не пустое, значение должно быть целым числом больше нуля.

PUT /api/pulse/:id

Обновить Пульс с id.

Параметры:

  • skip_if_empty значение может быть пустым, или если не пустое, значение должно быть логическим.

  • parameters значение должно быть массивом. Каждое значение должно быть картой.

  • archived значение может быть пустым, или если не пустое, значение должно быть логическим.

  • channels значение может быть пустым, или если не пустое, значение должно быть массивом. Каждое значение должно быть картой. Массив не должен быть пустым.

  • collection_id значение может быть пустым, или если не пустое, значение должно быть целым числом больше нуля.

  • name значение может быть пустым, или если не пустое, значение должно быть не пустой строкой.

  • id

  • cards значение может быть пустым, или если не пустое, значение должно быть массивом. Каждое значение должно отвечать одному из следующих требований: 1) значение должно быть картой со следующими ключами (collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings) 2) значение должно быть картой с ключами id, include_csv, include_xls, и dashboard_card_id. Массив не должен быть пустым.

  • pulse-updates

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