Карточки

/api/card методы.

DELETE /api/card/:id

Удалить карточку (DEPRECATED – теперь карточки будут не удаляться, а архивироваться).

Параметры:

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

GET /api/card/

Получить все карточки. Параметр фильтрации f может использоваться для изменения набора возвращаемых карточек; по умолчанию это all, но другие варианты включают mine, bookmarked, database, table, recent, popular, :using_model и archived. См. соответствующие функции реализации для конкретного поведения каждого параметра фильтрации. :card_index.

Параметры:

  • f перечисление archived, table, using_model, bookmarked, popular, all, recent, mine, database; могущее быть пустым.

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

GET /api/card/:card-id/params/:param-key/search/:query

Получить список возможных значений параметра, ID которого :param-key содержащий :query.

;; получить значения для Card 1 параметра 'abc' который содержит 'Orange';
 GET /api/card/1/params/abc/search/Orange

Ограничено первыми 1000 записями.

Параметры:

  • card-id значение должно быть целым, больше нуля.

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

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

GET /api/card/:card-id/params/:param-key/values

Получить список возможных значений параметра, ID которого :param-key.

;; получить для Card 1 возможные значения параметра 'abc'
GET /api/card/1/params/abc/values.

Параметры:

  • card-id значение должно быть целым, больше нуля.

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

GET /api/card/:id

Получить Card с ID.

Параметры:

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

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

GET /api/card/:id/series

Получает список совместимых серий с картой с id card_id.

  • last_cursor с значением - это идентификатор последней карты с предыдущей страницы для получения следующей страницы.

  • query для поиска карты по имени.

  • exclude_ids для фильтрации списка идентификаторов карт.

Параметры:

  • id целое

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

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

  • exclude_ids функция, может быть пустой.

GET /api/card/:id/timelines

Получить таймлайны для карточки с ID. Ищет коллекцию, в которой находится карточка, и использует ее.

Параметры:

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

  • include должно быть равно events, может быть пустым.

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

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

GET /api/card/embeddable

Получает список карточек, где enable_embedding является true. Карточки могут быть встроены с помощью метода встраивания и подписанного токена JWT.

GET /api/card/public

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

POST /api/card/

Создать новую Card.

Параметры:

  • visualization_settings значение должно быть картой.

  • parameters значение может быть пустым или не пустым, значение должно быть массивом. Каждый параметр должен быть картой с ключами :id и :type.

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

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

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

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

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

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

  • dataset_query значение должно быть картой.

  • parameter_mappings значение может быть пустым или не пустым, значение должно быть массивом. Каждый parameter_mapping должен быть картой с ключами :parameter_id и :target

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

POST /api/card/:card-id/persist

Отметить модель (карточку) как сохраненную. Запускает запрос и сохраняет его в базе данных. Производит моментальную замену (hot swap) запроса на запрос самой модели.

Параметры:

  • card-id целое значение больше нуля.

POST /api/card/:card-id/public_link

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

Параметры:

  • card-id значение должно быть целым числом больше нуля.

POST /api/card/:card-id/query

Запустить запрос, связанный с карточкой.

Параметры:

  • card-id значение должно быть целым числом больше нуля.

  • parameters

  • ignore_cache булево значение, может быть пустым.

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

  • collection_preview булево значение, может быть пустым.

POST /api/card/:card-id/query/:export-format

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

parametersдолжны быть переданы как параметр запроса, сериализованный в виде строки JSON (это обычно используется для кнопок “Загрузить результаты”, которые используют действия формы HTML).

Параметры:

  • card-id значение должно быть целым числом больше нуля.

  • export-format перечисление api, csv, json, xlsx.

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

POST /api/card/:card-id/refresh

Обновить кэш сохраненной модели с card-id.

Параметры:

  • card-id целое значение больше нуля.

POST /api/card/:card-id/unpersist

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

Параметры:

  • card-id целое значение больше нуля.

POST /api/card/:id/copy

Копировать Card, с новым названием ‘Copy of name’.

Параметры:

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

POST /api/card/collections

Массовое обновление коллекций карточек. Переместить набор карточек CARD_IDS в collection c COLLECTION_ID или удалить их из любых коллекций, передав значение null в COLLECTION_ID.

Параметры:

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

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

POST /api/card/from-csv

Создает таблицу и модель, заполненную значениями из прикрепленного CSV. Возвращает идентификатор модели в случае успеха.

Параметры:

  • raw-params

POST /api/card/pivot/:card-id/query

Запустить новый запрос, связанный с карточкой.

Параметры:

  • card-id значение должно быть целым числом больше нуля.

  • parameters

  • ignore_cache Булево значение, может быть пустым.

POST /api/card/related

Возвращает связанные сущности для ad-hoc запроса.

Параметры:

  • query

PUT /api/card/:id

Обновление Card.

Параметры:

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

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

  • parameters значение может быть пустым или не пустым, значение должно быть массивом. Каждый параметр должен быть картой с ключами :id и :type

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

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

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

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

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

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

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

  • card-updates

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

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

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

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

  • id

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

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