Документация InstantCMS

для администраторов и разработчиков

Инструменты пользователя

Инструменты сайта


manual:components:api:methods:content-get

content.get.CTYPE

Возвращает записи для заданного типа контента.

Параметры

Название Описание
page Номер страницы с результатами. Положительное число, по умолчанию — 1. Параметр необязательный.
cat_id id категории, записи которой нужно вернуть. Положительное число. Параметр необязательный.
folder_id id папки. Положительное число. Параметр необязательный.
user_id id пользователя, принадлежащие записи которому нужно вернуть. Положительное число. Параметр необязательный.
group_id id группы, принадлежащие записи к которой необходимо вернуть. Положительное число. Параметр необязательный.
dataset_id id набора, который нужно применить к списку записей. Положительное число. Параметр необязательный.
is_not_paginated 1 — не разбивать результат на страницы. При получении больших объёмов данных не рекомендуется использовать данный параметр. Флаг, может принимать значения 1 или 0. Параметр необязательный.
ids Идентификаторы записей (их id), информацию о которых необходимо вернуть. Список положительных чисел, разделенных запятыми. Параметр необязательный.

Кроме перечисленных выше параметров, метод принимает параметры от полей фильтра (в том числе и от полей свойств). Список полей, по которым можно фильтровать вы можете получить при помощи метода content.get_fields.CTYPE передав ему параметр is_in_filter равный 1. Аналогично выполняется запрос и для полей свойств.

CTYPE в названии метода - это имя типа контента, например news, board и т.п.

Пример

instantcms_site.ru/api/method/content.get.board?api_key=API_KEY

Результат

После успешного выполнения возвращает объект, содержащий общее число записей типа контента в поле count, массив объектов записей в поле items, объект paging разбивки на страницы и объект additionally, в котором показаны объекты:

  • категория category, если таковая передана в параметрах;
  • текущий тип контента ctype;
  • набор dataset, если передан в параметрах;
  • список полей fields выбранного типа контента;
  • объект filters (в формате ключ фильтрации ⇒ значение), если дополнительно список отфильтрован при помощи полей фильтра;
  • группа group, если таковая передана;
  • свойства категорий props, если таковые есть.

Коды ошибок

В ходе выполнения могут произойти общие ошибки.


Назад к описанию методов API

manual/components/api/methods/content-get.txt · Последние изменения: 04.09.2017 16:36 — fuze