Получить папки сайта landing.site.getFolders

Scope: landing

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

Метод landing.site.getFolders возвращает список папок сайта.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

siteId*
integer

Идентификатор сайта, для которого запрашиваются папки.

Идентификатор сайта можно получить с помощью метода landing.site.getList или из результата метода landing.site.add

filter
object

Фильтр по полям папки (подробное описание)

Параметр filter

Название
тип

Описание

ID
integer

Идентификатор папки

PARENT_ID
integer | null

Идентификатор родительской папки. Если передать 0, null, false или пустую строку, значение будет приведено к null, это выборка папок верхнего уровня

INDEX_ID
integer

Идентификатор индексной страницы папки

ACTIVE
string

Флаг активности Y/N

DELETED
string

Флаг удаления Y/N

=DELETED
string

Точное сравнение флага удаления. Если в запросе нет DELETED и =DELETED, метод автоматически добавляет =DELETED: "N"

TITLE
string

Название папки

CODE
string

Символьный код папки

CREATED_BY_ID
integer

Идентификатор пользователя, создавшего папку

MODIFIED_BY_ID
integer

Идентификатор пользователя, изменившего папку

DATE_CREATE
datetime

Дата и время создания папки

DATE_MODIFY
datetime

Дата и время изменения папки

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 1817,
            "filter": {
              "PARENT_ID": 0,
              "=DELETED": "N",
              "ACTIVE": "Y"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.getFolders.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 1817,
            "filter": {
              "PARENT_ID": 0,
              "=DELETED": "N",
              "ACTIVE": "Y"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.getFolders.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.site.getFolders',
        		{
        			siteId: 1817,
        			filter: {
        				PARENT_ID: 0,
        				'=DELETED': 'N',
        				ACTIVE: 'Y'
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.getFolders',
                    [
                        'siteId' => 1817,
                        'filter' => [
                            'PARENT_ID' => 0,
                            '=DELETED' => 'N',
                            'ACTIVE' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting folders: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.site.getFolders',
            {
                siteId: 1817,
                filter: {
                    PARENT_ID: 0,
                    '=DELETED': 'N',
                    ACTIVE: 'Y'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.getFolders',
            [
                'siteId' => 1817,
                'filter' => [
                    'PARENT_ID' => 0,
                    '=DELETED' => 'N',
                    'ACTIVE' => 'Y',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "1",
                    "PARENT_ID": null,
                    "SITE_ID": "3",
                    "INDEX_ID": "9",
                    "ACTIVE": "Y",
                    "DELETED": "N",
                    "TITLE": "тест переноса страниц",
                    "CODE": "change",
                    "CREATED_BY_ID": "1",
                    "MODIFIED_BY_ID": "29",
                    "DATE_CREATE": "11/12/2021 08:39:53 pm",
                    "DATE_MODIFY": "12/28/2021 03:04:04 pm"
                },
                {
                    "ID": "33",
                    "PARENT_ID": null,
                    "SITE_ID": "3",
                    "INDEX_ID": null,
                    "ACTIVE": "Y",
                    "DELETED": "N",
                    "TITLE": "mobile",
                    "CODE": "mobile",
                    "CREATED_BY_ID": "29",
                    "MODIFIED_BY_ID": "29",
                    "DATE_CREATE": "12/08/2021 10:23:37 am",
                    "DATE_MODIFY": "12/08/2021 10:24:48 am"
                },
                {
                    "ID": "3",
                    "PARENT_ID": null,
                    "SITE_ID": "3",
                    "INDEX_ID": "45",
                    "ACTIVE": "Y",
                    "DELETED": "N",
                    "TITLE": "вложение 1",
                    "CODE": "vlozhenie1",
                    "CREATED_BY_ID": "1",
                    "MODIFIED_BY_ID": "29",
                    "DATE_CREATE": "11/12/2021 08:39:53 pm",
                    "DATE_MODIFY": "12/03/2021 08:10:21 am"
                }
            ],
            "time": {
                "start": 1773257990,
                "finish": 1773257990.091689,
                "duration": 0.0916891098022461,
                "processing": 0,
                "date_start": "2026-03-11T22:39:50+03:00",
                "date_finish": "2026-03-11T22:39:50+03:00",
                "operating_reset_at": 1773258590,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object[]

Список папок сайта (подробное описание). Метод может вернуть result: [] без ошибки, если в сайте нет папок или у пользователя нет права «просмотр» для указанного сайта

time
time

Информация о времени выполнения запроса

Объект folder

Название
тип

Описание

ID
string

Идентификатор папки

PARENT_ID
string | null

Идентификатор родительской папки

SITE_ID
string

Идентификатор сайта

INDEX_ID
string | null

Идентификатор индексной страницы папки

ACTIVE
string

Флаг активности Y/N

DELETED
string

Флаг удаления Y/N

TITLE
string

Название папки

CODE
string

Символьный код папки

CREATED_BY_ID
string

Идентификатор пользователя, создавшего папку

MODIFIED_BY_ID
string

Идентификатор пользователя, изменившего папку

DATE_CREATE
string

Дата и время создания в строковом формате

DATE_MODIFY
string

Дата и время изменения в строковом формате

Обработка ошибок

HTTP-статус: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Недостаточно параметров вызова, пропущены: siteId"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

MISSING_PARAMS

Не передан обязательный параметр siteId

ACCESS_DENIED

Недостаточно общих прав для вызова методов landing

TYPE_ERROR

Ошибка типа данных в параметрах вызова метода

SYSTEM_ERROR

Внутренняя ошибка при выполнении метода

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Экспортировать сайт
Следующая
Получить список сайтов