Объект

GET

/api/v1/tables/{schema}/{name}

curl --request GET \
  --url https://demo.goodwink.ru/api/v1/tables/example/example \
  --header 'Authorization: Bearer <token>'

• адрес вашего кабинета

Объект со столбцами, первичным ключом и запросом представления

Authorizations

• bearer
• apiKey

Parameters

Path Parameters

schema

required

string

name

required

string

Responses

200

Успех

Media typeapplication/json

object

schema

required

Sources — таблицы источников, public и свои схемы — объекты клиента

string

name

required

string

kind

required

Таблица, представление, материализованное представление

string

Allowed values: table view matview

source

required

One of:

object

object

id

required

integer

name

required

string

null

null

comment

required

Описание объекта (COMMENT ON)

string | null

rows_estimate

required

Оценка числа строк по каталогу Postgres; у представления null

integer | null

columns

Array<object>

object

name

required

Имя в базе — им пишется выборка и ключ строки

string

type

required

Тип Postgres: bigint, numeric, text, timestamp with time zone…

string

label

required

Как на экране: у таблицы источника — исходное имя поля

string

comment

string | null

key

Первичный ключ

Array<string>

definition

Запрос представления

string | null

Example

{
  "kind": "table"
}

Headers

X-RateLimit-Limit

integer

Лимит запросов в минуту на ключ

X-RateLimit-Remaining

integer

Сколько осталось в этой минуте

400

Параметр не того вида, неизвестный (unknown_param) или выборка не применяется

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable

code

required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string

message

required

Что ждали — словами

string

param

required

Виноватый параметр

string | null

Example

{
  "error": {
    "type": "invalid_request"
  }
}

401

Нет ключа, ключ неверный или отозван; WWW-Authenticate: Bearer

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable

code

required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string

message

required

Что ждали — словами

string

param

required

Виноватый параметр

string | null

Example

{
  "error": {
    "type": "invalid_request"
  }
}

404

Нет такого источника или объекта

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable

code

required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string

message

required

Что ждали — словами

string

param

required

Виноватый параметр

string | null

Example

{
  "error": {
    "type": "invalid_request"
  }
}

429

Превышен лимит запросов на ключ; Retry-After — через сколько секунд

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request unauthorized not_found conflict rate_limited unavailable

code

required

Машинный код: unknown_param, bad_limit, bad_cursor, bad_source_id, bad_channel, bad_filter, bad_fo, bad_fv, bad_dir, bad_period, unknown_column, bad_columns, bad_selection, invalid_key, rate_limited, no_such_source, no_such_table, table_busy, query_failed, query_timeout, reader_off

string

message

required

Что ждали — словами

string

param

required

Виноватый параметр

string | null

Example

{
  "error": {
    "type": "invalid_request"
  }
}