Список элементов

GET /core/static/items

Описание

Этот эндпоинт используется для получения списка элементов. Каждый элемент содержит базовые данные, такие как имя, URL, статус активности, и дополнительные метаданные. Эндпоинт полезен для отображения статических данных на фронтенде или для выполнения операций с данными.

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

Обязательные параметры:

Нет

Вспомогательные параметры:

sortBy — параметр для сортировки по указанному полю
sortOrder — порядок сортировки: ASC (по возрастанию) или DESC (по убыванию).
limit — ограничение на количество записей, возвращаемых в одном запросе.
page — номер страницы для постраничного вывода данных.

Пример:

GET /core/static/items?sortBy=name&sortOrder=ASC&limit=20&page=1

Ответ

Возвращается в формате JSON и содержит следующую структуру данных:

id — Уникальный идентификатор элемента.
name — Название элемента.
url — URL элемента.
active — Статус активности (true / false).
hits — Количество обращений к элементу.
sort — Порядок сортировки элемента.
fields — Дополнительные данные в формате JSON.
sectionId — Идентификатор родительского раздела (если есть).
createdAt — Дата и время создания элемента.
updatedAt — Дата и время последнего обновления элемента.

GET

/core/static/items

При успешном запросе, ответ будет выглядеть так:

1{
2  "status": "success",
3  "payload": [
4    {
5      "id": 1,
6      "name": "home_teaser",
7      "url": "home_teaser",
8      "active": true,
9      "hits": 10,
10      "sort": 500,
11      "fields": null,
12      "sectionId": null,
13      "createdAt": "2024-08-28T13:54:02.000Z",
14      "updatedAt": "2024-10-12T05:46:31.000Z"
15    }
16  ],
17  "pagination": {
18    "limit": 20,
19    "offset": 0,
20    "currentTotal": 1,
21    "total": 1,
22    "page": 1
23  }
24}

Интерфейс

1interface IStatik {
2  id: number;
3  name: string;
4  url: string;
5  hits: number;
6  sort: number;
7  sectionId: number | null;
8  fields: {
9    [key: string]: any
10  };
11  active: boolean;
12}