Skip to content

Получить статьи

Получить статьи#

Ручка#

POST /lk/v1/wiki/fetch_article

Полный адрес в сети#

Среда URL
🧪 Dev https://gateway.devterra.ru/lk/v1/wiki/fetch_article
🚀 Prod https://mobile-api.terraprod.ru/lk/v1/wiki/fetch_article

Пример запроса#

{
    "filters": {
        "articleType": 0,
        "createdAt": "2024-11-06T19:30:00+03:00",
        "createdTo": "2024-11-06T19:30:00+03:00",
        "orderByCreatedAt": true
    },
    "pagination": {
        "limit": 1,
        "page": 1
    }
}
Столбец Тип Описание Обязательность Пример
filters object Фильтры, по которым будут отобраны статьи для получения ❌ см. ниже
pagination object Параметры пагинации ❌ см. ниже
filters#
Столбец Тип Описание Обязательность Пример
articleType int32 Тип статьи ❌ 0
createdAt string Стартовый промежуток времени создания статьи ❌ "2024-11-06T19:30:00+03:00"
createdTo string Конечный промежуток времени создания статьи ❌ "2024-11-06T19:30:00+03:00"
orderByCreatedAt bool Флаг, сортировать ли по времени создания ❌ false
pagination#
Поле Тип Описание Обязательное Пример
limit int32 Общее количество элементов ❌ 1
page int32 Текущая страница ❌ 1

Пример тела ответа#

{
    "pageTitle":  "Wiki",
    "data":  [
        {
            "component": [
                "uuid":      "8a87d1a5-5bce-4361-a2e6-8b5517c81212",
                "type":      2
                "typeName":  "TEXT_BODY",
                "content":   "Настройка систем аналитики",
                "priority":  1,
                "createdAt": "2024-11-06T19:30:00+03:00",
                "updatedAt": "2024-12-06T19:30:00+03:00",
                "deletedAt": "2025-11-06T19:30:00+03:00"
            ]
        }
    ],
    "pagination": {
        "currentPage": 1,
        "itemsPerPage": 1,
        "totalItems": 1,
        "totalPages": 1
    }
}
Столбец Тип Описание Обязательность Пример
pageTitle string Название страницы ✅ "Wiki"
uuid string Уникальный идентификатор компонента ✅ "8a87d1a5-5bce-4361-a2e6-8b5517c81212"
type int32 Тип конпонента ✅ 1
typeName string Название типа конпонента ✅ "TEXT_BODY"
content string Содержание компонента ✅ "Настройка систем аналитики"
priority int32 Приоритет компонента ✅ 1
createdAt string Время создания компонента ✅ "2024-11-06T19:30:00+03:00"
updatedAt string Время обновления компонента ✅ "2024-11-06T19:30:00+03:00"
deletedAt string Время удаления компонента ✅ "2024-11-06T19:30:00+03:00"
pagination#
Поле Тип Описание Обязательное
currentPage int32 Текущая страница ✅
itemsPerPage int32 Количество элементов на странице ✅
totalItems int32 Общее количество элементов ✅
totalPages int32 Общее количество страниц ✅