disk-folder-get-fields.md

Получить описание полей папки disk.folder.getfields

{% if build == 'dev' %}

{% note alert "TO-DO не выгружается на prod" %}

• отсутствуют примеры (должно быть три примера - curl, js, php)
• отсутствует ответ в случае ошибки

{% endnote %}

{% endif %}

{% note warning "Мы еще обновляем эту страницу" %}

Тут может не хватать некоторых данных — дополним в ближайшее время

{% endnote %}

Scope: disk

Кто может выполнять метод: любой пользователь

Метод disk.folder.getfields возвращает описание полей папки.

• TYPE — тип поля;
• USE_IN_FILTER — возможность использовать поле при фильтрации выборки;
• USE_IN_SHOW — доступно ли это поле при получении ответа.

Параметры

Без параметров.

Пример

BX24.callMethod(
    "disk.folder.getfields",
    {},
    function (result)
    {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

{% include Сноска о примерах %}

Ответ в случае успеха

200 OK

"result": {
    "ID": {
        "TYPE": "integer",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    },
    "NAME": {
        "TYPE": "string",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    },
    "TYPE": {
        "TYPE": "enum",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    },
    "CODE": {
        "TYPE": "string",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    },
    "STORAGE_ID": {
        "TYPE": "integer",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    },
    "REAL_OBJECT_ID": {
        "TYPE": "integer",
        "USE_IN_FILTER": false,
        "USE_IN_SHOW": true
    },
    "PARENT_ID": {
        "TYPE": "integer",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    },
    "CREATE_TIME": {
        "TYPE": "datetime",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    },
    "UPDATE_TIME": {
        "TYPE": "datetime",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    },
    "DELETE_TIME": {
        "TYPE": "datetime",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    },
    "CREATED_BY": {
        "TYPE": "integer",
        "USE_IN_FILTER": false,
        "USE_IN_SHOW": true
    },
    "UPDATED_BY": {
        "TYPE": "integer",
        "USE_IN_FILTER": false,
        "USE_IN_SHOW": true
    },
    "DELETED_BY": {
        "TYPE": "integer",
        "USE_IN_FILTER": false,
        "USE_IN_SHOW": true
    },
    "DELETED_TYPE": {
        "TYPE": "enum",
        "USE_IN_FILTER": true,
        "USE_IN_SHOW": true
    }
}