entity.section.get

Scope: entity Права на выполнение: для всех

Описание и пример

Получение списка разделов хранилища (секций инфоблока). Списочный метод.

Пользователь должен обладать хотя бы правами на чтение (R) хранилища.

Пример

Вызов

BX24.callMethod('entity.section.get', {ENTITY: 'menu_new', SORT: {'NAME': 'ASC'}}, function(result){
	sections = result.data();
});

Запрос

https://my.bitrix24.ru/rest/entity.section.get.json?ENTITY=menu_new&SORT%5BNAME%5D=ASC&auth=9affe382af74d9c5caa588e28096e872

Ответ

{"result":[{"ID":"219","CODE":null,"TIMESTAMP_X":"2013-06-23T10:11:59+03:00","DATE_CREATE":"2013-06-23T10:11:59+03:00","CREATED_BY":"1","MODIFIED_BY":"1","ACTIVE":"Y","SORT":"500","NAME":"\u0412\u0442\u043e\u0440\u0430\u044f \u0442\u0435\u0441\u0442\u043e\u0432\u0430\u044f \u0441\u0435\u043a\u0446\u0438\u044f","PICTURE":null,"DETAIL_PICTURE":null,"DESCRIPTION":null,"LEFT_MARGIN":"1","RIGHT_MARGIN":"2","DEPTH_LEVEL":"1","ENTITY":"menu_new","SECTION":null},{"ID":"218","CODE":null,"TIMESTAMP_X":"2013-06-23T10:24:46+03:00","DATE_CREATE":"2013-06-23T10:08:54+03:00","CREATED_BY":"1","MODIFIED_BY":"1","ACTIVE":"Y","SORT":"500","NAME":"\u041f\u0435\u0440\u0432\u0430\u044f \u0442\u0435\u0441\u0442\u043e\u0432\u0430\u044f \u0441\u0435\u043a\u0446\u0438\u044f","PICTURE":null,"DETAIL_PICTURE":null,"DESCRIPTION":null,"LEFT_MARGIN":"3","RIGHT_MARGIN":"4","DEPTH_LEVEL":"1","ENTITY":"menu_new","SECTION":null}],"total":2}

Параметры

Параметр	Описание
ENTITY	Обязательный. Строковой идентификатор хранилища.
SORT	Массив для сортировки, имеющий вид by1=>order1[, by2=>order2 [, ..]], где by1, ... - поле сортировки, может принимать значения: ID - код раздела; SECTION - код родительской раздела; NAME - название раздела; CODE - символьный код раздела; ACTIVE - активности раздела LEFT_MARGIN - левая граница; DEPTH_LEVEL - глубина вложенности (начинается с 1); SORT - индекс сортировки; CREATED - по времени создания раздела; CREATED_BY - по идентификатору создателя раздела; MODIFIED_BY - по идентификатору пользователя изменившего раздела; TIMESTAMP_X - по времени последнего изменения. order1, ... - порядок сортировки, может принимать значения: ASC - по возрастанию; DESC - по убыванию. Значение по умолчанию Array("SORT"=>"ASC") означает, что результат выборки будет отсортирован по возрастанию. Если задать пустой массив Array(), то результат отсортирован не будет.
FILTER	Массив вида array("фильтруемое поле"=>"значение" [, ...]). Фильтруемое поле может принимать значения: ACTIVE - фильтр по активности (Y\|N); NAME - по названию (можно искать по шаблону [%_]); CODE - по символьному коду (по шаблону [%_]); SECTION_ID - по коду раздела-родителя (если указать false, то будут возвращены корневые разделы); DEPTH_LEVEL - по уровню вложенности (начинается с 1); LEFT_MARGIN, RIGHT_MARGIN - по положению в дереве (используется, когда необходима выборка дерева подразделов; ID - по коду раздела; TIMESTAMP_X - по времени последнего изменения; DATE_CREATE - по времени создания; MODIFIED_BY - по коду пользователя изменившему раздел; CREATED_BY - по содателю; Все фильтруемые поля могут содержать перед названием тип проверки фильтра. Необязательное. По умолчанию записи не фильтруются.

Параметр

Описание

ENTITY

Обязательный. Строковой идентификатор хранилища.

SORT

Массив для сортировки, имеющий вид by1=>order1[, by2=>order2 [, ..]], где by1, ... - поле сортировки, может принимать значения:

ID - код раздела;
SECTION - код родительской раздела;
NAME - название раздела;
CODE - символьный код раздела;
ACTIVE - активности раздела
LEFT_MARGIN - левая граница;
DEPTH_LEVEL - глубина вложенности (начинается с 1);
SORT - индекс сортировки;
CREATED - по времени создания раздела;
CREATED_BY - по идентификатору создателя раздела;
MODIFIED_BY - по идентификатору пользователя изменившего раздела;
TIMESTAMP_X - по времени последнего изменения.

order1, ... - порядок сортировки, может принимать значения:

ASC - по возрастанию;
DESC - по убыванию.

Значение по умолчанию Array("SORT"=>"ASC") означает, что результат выборки будет отсортирован по возрастанию. Если задать пустой массив Array(), то результат отсортирован не будет.

FILTER

Массив вида array("фильтруемое поле"=>"значение" [, ...]). Фильтруемое поле может принимать значения:

ACTIVE - фильтр по активности (Y|N);
NAME - по названию (можно искать по шаблону [%_]);
CODE - по символьному коду (по шаблону [%_]);
SECTION_ID - по коду раздела-родителя (если указать false, то будут возвращены корневые разделы);
DEPTH_LEVEL - по уровню вложенности (начинается с 1);
LEFT_MARGIN, RIGHT_MARGIN - по положению в дереве (используется, когда необходима выборка дерева подразделов;
ID - по коду раздела;
TIMESTAMP_X - по времени последнего изменения;
DATE_CREATE - по времени создания;
MODIFIED_BY - по коду пользователя изменившему раздел;
CREATED_BY - по содателю;

Все фильтруемые поля могут содержать перед названием тип проверки фильтра.

Необязательное. По умолчанию записи не фильтруются.

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

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

0 Nerey 25.08.2015 16:50:41 Сообщение не промодерировано, возможны ошибки и неточности.
"BX24.callMethod('entity.section.get', {ENTITY: 'menu_new', SORT: {'NAME': 'ASC'}}, function®{ sections = r.data();" Код в примере не полный.