Skip to end of metadata
Go to start of metadata

Описание

Получить информацию о полях, используемых в базе данных

URL-адрес

Метод: POST

https://example.com/api/v1.1/databases/fields_get/

Параметры запроса

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
idint1ДаИдентификатор базы данных
formatint"json"НетФормат возвращаемых данных
по умолчанию – "json"

Пример запроса

{
    "id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Пример ответа

{
    "data": [
        {
            "category": "custom",
            "enum_values": [
                {
                    "name": "GMail",
                    "value": 2
                },
                {
                    "name": "HotMail",
                    "value": 3
                },
                {
                    "name": "Yahoo!",
                    "value": 1
                }
            ],
            "name": "Custom_Enum",
            "required": false,
            "title": "Custom_Enum"
        },
        {
            "category": "custom",
            "enum_values": null,
            "name": "Custom_Tags",
            "required": false,
            "title": "Custom_Tags"
        },
        {
            "category": "default",
            "enum_values": null,
            "name": "_fname",
            "required": false,
            "title": "FirstName"
        },
        {
            "category": "system",
            "enum_values": null,
            "name": "_id",
            "required": true,
            "title": "Id"
        }
    ],
    "error": 0,
    "error_text": "Successful operation"
}

Возвращаемые параметры

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
categorystring

Категория поля базы:
system, default, custom

enum_valuesarrayЗначения полей со списком
вариантов
namestringНазвание поля для запросов
requiredboolОбязательное поле (true)
titlestringНазвание поля для
интерфейса
  • No labels