Объект «Навигация» в API

Объект «Навигация» в API

Списочные методы выдают результат страницами. Чтобы ими управлять, используется объект данных «Навигация». Он описывает:

  • номер страницы;
  • число записей на странице;
  • вариант информирования о наличии страниц после запрошенной страницы.

Для команды «СБИС.СписокИзменений» используется упрощенный вариант объекта «Навигация».

Для всех команд
Для всех команд
Для «СБИС.СписокИзменений»
Для «СБИС.СписокИзменений»

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

  • Объект "Фильтр":
    • ...
    • "Навигация": объект:
      • "РазмерСтраницы": строка, запрошенное число записей
      • "Страница": строка, номер страницы, с которой будет сделана выборка. Нумерация страниц от 0 (для первой страницы)

Результат запроса

Результат выполнения команды дополняется объектом «Навигация»:

Синие — поля, доступные только для чтения (т.е. в возвращаемых значениях с сервера).

  • ... (результат выполнения — объект, массив объектов)
  • "Навигация": объект:
    • "Страница": строка, номер страницы, с которой сделана выборка. Нумерация начинается с нуля, по умолчанию — 0
    • "ЕстьЕще": строка "Да"/"Нет"
    • "РазмерСтраницы": строка, запрошенное число записей. Диапазон значений от 1 до 200, по умолчанию — 25

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

  • Объект "Фильтр":
    • ...
    • "Навигация": объект
      • "РазмерСтраницы": строка, число записей на странице, возвращенной в качестве результата. Диапазон значений от 0 до 50, по умолчанию — 25

Результат запроса

Результат выполнения команды дополняется объектом «Навигация»:

  • ... (результат выполнения — объект, массив объектов)
  • "Навигация": объект:
    • "РазмерСтраницы": строка, указывает число записей на странице, возвращенной в качестве результата
    • "ЕстьЕще": строка "Да"/"Нет"

Примеры

Запрос

Ответ

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.