Строки объекта

GET

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

curl --request GET \
  --url 'https://demo.goodwink.ru/api/v1/tables/example/example/rows?dir=asc&limit=100' \
  --header 'Authorization: Bearer <token>'

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

Строки по описанию выборки экрана таблицы: поиск, фильтры, период, сортировка, видимые столбцы — те же параметры, что в адресе экрана; страницы — limit и cursor

Authorizations

• bearer
• apiKey

Parameters

Path Parameters

schema

required

string

name

required

string

Query Parameters

q

string

Поиск-подстрока по всем столбцам строки, без учёта регистра

fc

Array<string>

Фильтр: столбец; повторяется — по одному на фильтр, тройкой с fo и fv

fo

Array<string>

Allowed values: eq ne gt ge lt le contains empty notempty

Фильтр: условие

fv

Array<string>

Фильтр: значение, по порядку фильтров; у empty и notempty — пустое, в конце можно опустить

per

string

Период: столбец даты

from

string format: date

Период: с даты включительно (ГГГГ-ММ-ДД, в поясе кабинета)

to

string format: date

Период: по дату включительно

sort

string

Сортировка: столбец; без неё у таблицы источника — свежие сверху

dir

string

Allowed values: asc desc

Направление сортировки

col

Array<string>

Ровно эти столбцы по порядку; повторяется; нет — все

order

Array<string>

Без col: эти столбцы впереди, по порядку, остальные — в порядке таблицы; повторяется

hide

Array<string>

Без col: скрытые столбцы; новое поле таблицы видно само; повторяется

limit

integer

default: 100 >= 1 <= 1000

Сколько вернуть за запрос; вне 1–1000 — 400

cursor

string

Next_cursor прошлого ответа, как есть

Responses

200

Успех

Media typeapplication/json

object

data

required

Array<object>

Строка: ключи — столбцы из columns; число — числом, дата — ГГГГ-ММ-ДД, дата и время с поясом — RFC 3339 в UTC, без пояса — ГГГГ-ММ-ДДTчч:мм:сс, структура (jsonb) — структурой

object

key

additional properties

any

has_more

required

boolean

next_cursor

required

Передавайте как cursor, пока has_more

string | 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

Example ^generated

{
  "data": [
    {}
  ],
  "has_more": true,
  "next_cursor": "example",
  "columns": [
    {
      "name": "example",
      "type": "example",
      "label": "example",
      "comment": "example"
    }
  ]
}

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"
  }
}

409

Таблица занята или запрос представления не исполнился — в message причина

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"
  }
}

503

Чтение недоступно или запрос не уложился в срок

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"
  }
}