data – Работа с данными в таблицах

Используется для работы с данными в пользовательских таблицах, адресация таблиц по идентификатору id

GET /data{table_id}

Получить список записей пользовательской таблицы

Request

URI Parameters

table_id: required(integer)

Идентификатор пользовательской таблицы

Headers

Content-Type: required(string)

Example:

application/vnd.api+json

X-Auth-Token: required(string)

Example:

vV3RSKE7AfBGrPKryBry2pnG0knK1NLbt765y0Aji2pOHhHV

Query Parameters

filter=EXPR: (string)

Задать условие отбора записей с помощью фильтр-выражения. Фильтр-выражение представляет собой композицию функций фильтрации, например

// Получить список мужчин младше 18 лет
filter=and(eq(sex,'male'),lt(age,'18'))
// Отобрать записи с полем f6400 равным "активный" ИЛИ полем f38 больше или равно 50
filter=or(eq(f6400,'активный'),gte(f38,'50'))

Доступные функции фильтрации

2023-09-26_14-25-12

Важно! Не применяется одновременно с заданием фильтра с помощью условий полей.

filter[FIELD]=OP: (string)

Задать фильтр отбора записей с помощью условий полей.

FIELD - имя поля, по которому осуществляется фильтрация

OP - применяемая операция сравнения: =, <, >, <=, >= (по умолчанию =)

Важно! Не применяется одновременно с заданием фильтра через фильтр-выражения.

Example:

отобрать записи со значением поля f6400 равным "активный"

filter[f6400]=активный

отобрать записи с значением поля f38 меньше 50

filter[f38]=<50

page[offset]: (integer - default: 0)

задать смещение выборки (с какой записи выбирать)

Example:

page[offset]=15

page[limit]: (integer - default: 20)

Задать количество возвращаемых записей в выборке

Example:

page[limit]=10

Respounce

HTTP status code 200

Body

Media type: application/vnd.api+json

Type: object

Example:

{
"data": [
{
  "type": "data371",
  "id": "501",
  "attributes": {
    "f201": "some value",
    "f202": "another value"
  }
},
{
  "type": "data371",
  "id": "502",
  "attributes": {
    "f201": "other value",
    "f202": "alter value"
  }
}
]
}

POST /data{table_id}

Создать запись в пользовательской таблице

Request

URI Parameters

table_id: required(integer)

Идентификатор пользовательской таблицы

Headers

Content-Type: required(string)

Example:

application/vnd.api+json

X-Auth-Token: required(string)

Example:

vV3RSKE7AfBGrPKryBry2pnG0knK1NLbt765y0Aji2pOHhHV

Body

Media type: application/vnd.api+json

Type: object

Properties

data: required(object)

type: required(string)

attributes: required(object)

Example:

{
"data": {
"type": "data371",
"attributes": {
  "f201": "some value",
  "f202": "another value",
  "f222": [
        {
          "file_name": "test.txt",
          "content": "111 222 333"
        },
        {
          "file_name": "image.png",
          "content":  ,
          "binary": true
        }
      ]

}
}
}

Response

HTTP status code 201

Body

Media type: application/vnd.api+json

Type: any

Media type: type

Type: object

Properties

data: required(object)

type: required(string)

имя ресурса (таблицы)

id: required(string)

идентификатор записи

attributes: required(object)

поля записи и их значения

Example:

{
"data": {
"type": "data371",
"id": "501",
"attributes": {
  "f201": "some value",
  "f202": "another value"
}
}
}
image: mail