Skip to main content

Список статей БЗ

GET /knowledge_base/articles/​

Пример URL​

https://домен_системы/api/v2/knowledge_base/articles/?page=1&public=true&category_list=1,2,3

Query-параметры​

ПараметрТипОбязательныйОписание
pageчислоНетНомер страницы (на странице показывается 10 статей)
publicстрокаНетПоиск по публичным статья: true - включить; false - выключить
category_listстрокаНетПоиск категорий по ID родительских категорий, через запятую
from_date_createdстрокаНетДата создания "от". Статьи, созданные с указанного момента (гггг-мм-дд чч:мм:сс)
to_date_createdстрокаНетДата создания "до". Статьи, созданные до указанного момента (гггг-мм-дд чч:мм:сс)
from_date_updatedстрокаНетДата изменения "от". Статьи, в которых были изменения с указанного момента (гггг-мм-дд чч:мм:сс)
to_date_updatedстрокаНетДата изменения "до". Статьи, в которых были изменения до указанного момента (гггг-мм-дд чч:мм:сс)
order_byстрокаНетСортировка статей, через запятую. Доступны параметры: date_created, date_updated, views, pin. Порядок сортировки: {asc} - по возрастанию и {desc} - по убыванию; Значение по умолчанию - date_created{desc}
Пример ответа
{
    "data": {
        "56": {
            "id": 56,
            "date_created": "2018-07-17 15:15:00",
            "date_updated": "2018-07-24 17:12:55",
            "created_by": 1,
            "updated_by": 1,
            "show_me_only": false,
            "access": "public",
            "pin": false,
            "views_count": 130,
            "categories": [
                1
            ],
            "title": {
                "ru": "Тестовая статья_1",
                "en": "Test article_1"
            },
            "tags": {
                "ru": [
                    "test",
                    "test2",
                    "test3"
                ],
                "en": []
            },
            "body": {
                "ru": "<p>Содержимое статьи в HTML</p>",
                "en": "<p>Body in HTML</p>"
            },
            "files": []
        },
        "57": {
            "id": 57,
            "date_created": "2018-07-17 15:15:00",
            "date_updated": "2018-07-24 17:27:27",
            "created_by": 1,
            "updated_by": 1,
            "show_me_only": false,
            "access": "staff",
            "pin": false,
            "views_count": 43,
            "categories": [
                1,
                2
            ],
            "title": {
                "ru": "Тестовая статья_2",
                "en": "Test article_2"
            },
            "tags": {
                "ru": [
                    "режим",
                    "серия pro"
                ],
                "en": []
            },
            "body": {
                "ru": "<p>Содержимое статьи в HTML</p>",
                "en": "<p>Body in HTML</p>"
            },
            "files": []
        },
        "58": {
            "id": 58,
            "date_created": "2018-07-17 15:15:00",
            "date_updated": "2018-07-17 15:15:00",
            "created_by": 1,
            "updated_by": 1,
            "show_me_only": false,
            "access": "user",
            "pin": false,
            "views_count": 3,
            "categories": [
                2
            ],
            "title": {
                "ru": "Тестовая статья_3",
                "en": "Test article_3"
            },
            "tags": {
                "ru": [
                    "ретранслятор"
                ],
                "en": [],
                "ua": []
            },
            "body": {
                "ru": "<p>Содержимое статьи в HTML</p>",
                "en": "<p>Body in HTML</p>"
            },
            "files": []
        },
        "60": {
            "id": 60,
            "date_created": "2024-07-24 17:24:00",
            "date_updated": "2024-02-01 18:04:21",
            "created_by": 1,
            "updated_by": 1,
            "show_me_only": false,
            "access": "public",
            "pin": false,
            "views_count": 32,
            "categories": [
                -2,
                2
            ],
            "title": {
                "ru": "Тестовая статья_4",
                "en": "Test article_4"
            },
            "tags": {
                "ru": [],
                "en": []
            },
            "body": {
                "ru": "<p>Содержимое статьи в HTML</p>",
                "en": "<p>Body in HTML</p>"
            },
            "files": [
                {
                    "name": "test.gif",
                    "url": "https://домен_системы/ru/knowledge_base/download/60/file/f8bb43e593d867d27c965d38dfec721fbb084cf9",
                    "data_type": "gif"
                },
                {
                    "name": "test.png",
                    "url": "https://домен_системы/ru/knowledge_base/download/60/file/b818daf594dd3b61098cce7fef7954bc0314edd5",
                    "data_type": "png"
                }
            ]
        }
    },
    "pagination": {
        "total": 4,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1
    }
}