# Карточки /api/card методы. ## `DELETE /api/card/:card-id/public_link` Удалить общедоступную ссылку на эту карточку. ### Параметры: * **`card-id`** целое число больше нуля. ## `DELETE /api/card/:id` Удалить карточку (DEPRECATED -- теперь карточки будут не удаляться, а архивироваться). ### Параметры: * **`id`** целое число больше нуля. ## `GET /api/card/` Получить все карточки. Параметр фильтрации `f` может использоваться для изменения набора возвращаемых карточек; по умолчанию это `all`, но другие варианты включают `mine`, `bookmarked`, `database`, `table`, `using_model`, `using_metric`, `using_segment`, and `archived`. См. соответствующие функции реализации для конкретного поведения каждого параметра фильтрации. :card_index. ### Параметры: * **`f`** null или один из `archived`, `table`, `using_model`, `bookmarked`, `all`, `mine`, `database`. * **`model_id`** целое число больше нуля или null. ## `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`** логическое значение или null. ## `GET /api/card/:id/related` Вернуть соответствующие сущности. ### Параметры: * **`id`** целое число больше нуля. ## `GET /api/card/:id/series` Получает список совместимых серий с картой с id `card_id`. - `last_cursor` идентификатор последней карты с предыдущей страницы для получения следующей страницы. - `query` для поиска карты по имени. - `exclude_ids` для фильтрации списка идентификаторов карт. ### Параметры: * **`id`** целое число. * **`last_cursor`** целое число больше нуля или null. * **`query`** непустая строка. * **`exclude_ids`** функция или null. ## `GET /api/card/:id/timelines` Получить таймлайны для карточки с `ID`. Ищет коллекцию, в которой находится карточка, и использует ее. ### Параметры: * **`id`** целое число больше нуля. * **`include`** должно быть равно `events` или null. * **`start`** корректная дата в строковом формате или null. * **`end`** корректная дата в строковом формате или null. ## `GET /api/card/embeddable` Получает список карточек, где `enable_embedding` является `true`. Карточки могут быть встроены с помощью метода встраивания и подписанного токена JWT. ## `GET /api/card/public` Получить список карточек с общедоступными UUID. Эти карточки будут доступны для общего использования, в том случае, если включена общая доступность. ## `POST /api/card/` Создать новую `Card`. ### Параметры: * **`visualization_settings`** карта. * **`parameters`** null или последовательность параметров, которая должна быть картой с ключами :id и :type. * **`dataset`** логическое значение или null. * **`description`** непустая строка или null. * **`collection_position`** целое число больше нуля или null. * **`result_metadata`** null или *:metabase.sync.analyze.query-results/ResultsMetadata*. * **`collection_id`** целое число больше нуля или null. * **`name`** непустая строка. * **`type`** перечисление модели, запроса, допускающее значение null. * **`cache_ttl`** обнуляемое значение должно быть целым числом больше нуля. * **`dataset_query`** карта. * **`parameter_mappings`** обнуляемая последовательность parameter_mapping должно быть картой с :parameter_id и :target keys. * **`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`** логическое значение или null. * **`dashboard_id`** целое число больше нуля или null. * **`collection_preview`** логическое значение или null. ## `POST /api/card/:card-id/query/:export-format` Запустить запрос, связанный с карточкой, и вернуть его результаты в виде файла в указанном формате. `parameters`должны быть переданы как параметр запроса, сериализованный в виде строки JSON (это обычно используется для кнопок "Загрузить результаты", которые используют действия `формы` HTML). ### Параметры: * **`card-id`** целое число больше нуля. * **`export-format`** перечисление `api`, `csv`, `json`, `xlsx`. * **`parameters`** допустимая строка JSON. * **`format_rows`** обнуляемое булевое значение. ## `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`** целое число больше нуля или null. ## `POST /api/card/collections` Массовое обновление коллекций карточек. Переместить набор `карточек` с `card_ids` в `коллекцию` c `collection_id` или удалить их из любых коллекций, передав значение `null` в `collection_id`. ### Параметры: * **`card_ids`** последовательность целых чисел больше нуля. * **`collection_id`** целое число больше нуля или null. ## `POST /api/card/from-csv` Создает таблицу и модель, заполненную значениями из прикрепленного CSV. Возвращает идентификатор модели в случае успеха. ### Параметры: * **`raw-params`** ## `POST /api/card/pivot/:card-id/query` Запустить новый запрос, связанный с карточкой. ### Параметры: * **`card-id`** целое число больше нуля. * **`parameters`** * **`ignore_cache`** логическое значение или null. ## `POST /api/card/related` Возвращает связанные сущности для ad-hoc запроса. ### Параметры: * **`query`** ## `PUT /api/card/:id` Обновление `Card`. ### Параметры: * **`collection_preview`** логическое значение или null. * **`visualization_settings`** карта или null. * **`parameters`** null или последовательность параметров, которая должна быть картой с ключами :id и :type. * **`dataset`** логическое значение или null. * **`description`** строка или null. * **`archived`** логическое значение или null. * **`collection_position`** целое число больше нуля или null. * **`result_metadata`** null или *:metabase.sync.analyze.query-results/ResultsMetadata*. * **`enable_embedding`** логическое значение или null. * **`collection_id`** целое число больше нуля или null. * **`card-updates`** * **`name`** непустая строка или null. * **`type`** обнуляемое перечисление модели, запроса. * **`embedding_params`** действительная карта параметров внедрения или null. * **`cache_ttl`** целое число больше нуля или null. * **`dataset_query`** карта или null. * **`id`** целое число больше нуля. * **`display`** непустая строка или null. --- [<< Назад к разделу API](./api-documentation.md)