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

Таблица

/api/table методы.

GET /api/table/

Получить все таблицы.

GET /api/table/:id

Получить таблицу по ID.

Параметры:

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

  • include_editable_data_model логическое значение или null.

GET /api/table/:id/fks

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

Параметры:

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

GET /api/table/:id/query_metadata

Получить метаданные о Table, необходимые для запуска запросов. Возвращает БД, поля, значения полей, FK полей.

При передаче include_hidden_fields=true в ответ будут включены все скрытые поля Fields. По умолчан — false.

При передаче include_sensitive_fields=true в ответ будут включены любые чувствительные поля Fields. По умолчанию - false.

При передаче include_editable_data_model=true проверит, что текущий пользователь имеет права на запись для таблицы модели данных, если false, то проверяет, есть ли у них права доступа к данным для таблицы. По умолчанию - false.

Эти параметры предоставляются для использования на странице редактирования метаданных администратора.

Параметры:

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

  • include_sensitive_fields допустимая логическая строка (true или false) или null.

  • include_hidden_fields допустимая логическая строка (true или false) или null.

  • include_editable_data_model допустимая логическая строка (true или false) или null.

GET /api/table/:id/related

Возвращает соответствующие сущности.

Параметры:

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

GET /api/table/card__:id/fks

Возвращает FK для виртуальной таблицы для Карточки. Возвращает всегда пустое значение, поэтому этот метод служит в основном в качестве заглушки, чтобы избежать необходимости что-либо менять в интерфейсе пользователя.

Параметры:

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

GET /api/table/card__:id/query_metadata

Возвращает метаданные для виртуальной таблицы для Карточки.

Параметры:

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

POST /api/table/:id/discard_values

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

Параметры:

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

POST /api/table/:id/rescan_values

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

Параметры:

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

PUT /api/table/

Обновляет все таблицы Table по ids.

Параметры:

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

  • display_name непустая строка или null.

  • entity_type допустимый тип сущности (ключевое слово или строка) или null.

  • visibility_type null или одно из: technical, hidden, cruft .

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

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

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

  • show_in_getting_started логическое значение или null.

PUT /api/table/:id

Обновляет Table по ID.

Параметры:

  • visibility_type null или одно из: technical, hidden, cruft .

  • field_order null или одно из: alphabetical, custom, database, smart.

  • display_name непустая строка или null.

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

  • entity_type допустимый тип сущности (ключевое слово или строка) или null.

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

  • show_in_getting_started логическое значение или null.

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

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

POST /api/table/:id/replace-csv

Заменяет содержимое таблицы, идентифицируемой по :id, строками загруженного CSV-файла. Таблица должна быть создана путём загрузки CSV-файла.

Параметры:

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

  • raw-params

PUT /api/table/:id/fields/order

Изменяет порядок полей.

Параметры:

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

  • field_order последовательность значений должна состоять из целых чисел больше нуля.

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