API для дашбордов и блокнотов
API для дашбордов и блокнотов
Платформа Ключ-АСТРОМ предоставляет набор сервисов платформы, каждый из которых отвечает за определённую область. Для управления документами Ключ-АСТРОМ, такими как дашборды и блокноты, через API нужен один из этих сервисов — сервис документов.
Доступ к данным документа
Приложения Дашборды и Блокноты используют API сервиса документов для сохранения данных в виде документов.
Документы не зависят от содержимого, но документы блокнотов и дашбордов имеют общие метаданные: уникальный идентификатор, имя и описание.
Чтобы различать документы блокнотов и дашбордов и делать их видимыми для соответствующих приложений, им нужен правильный атрибут типа документа: dashboard или notebook. Этот атрибут также можно использовать для запроса к API, как показано в следующих примерах.
Список всех доступных дашбордов https://environment/platform/document/v1/documents?filter=type='dashboard'
Список всех доступных блокнотов https://environment/platform/document/v1/documents?filter=type='notebook'
Доступ к полной документации сервиса документов
Чтобы увидеть полную документацию API для сервиса документов:
- Перейдите на страницу Document service на сайте разработчика Ключ-АСТРОМ.
- В разделе Связанные ссылки выберите ссылку Swagger API.
Возможно, потребуется войти в вашу среду Ключ-АСТРОМ.
