directory.structure

Оглавление

Что делает метод?
О Методе
Параметры
Возвращает при Выполнении
Примеры

Что делает метод?

Метод directory.structure возвращает структуру директории с вложенными статьями

О Методе

Тип Метода	Параметры Указываются
POST	в Body

Параметры

Параметры (ОБЯЗАТЕЛЬНЫЕ)	Тип		Описание
token	str	строка	Токен для интеграции

Возвращает при Выполнении

Возвращает (УСПЕШНО)

Тип

Описание

structure

list

список

Список с объектами директорий

Формат объекта директории

int

число

ID директории

parent_id

int

число

ID родительской директории

name

str

строка

Название директории

created

str

строка

Дата и время создания директории в формате ISO

edited

str

строка

Дата и время последнего редактирования директории в формате ISO

type

str

строка

Тип объекта

directories

list

список

Список с объектами директорий, принадлежащих этой директории

articles

list

список

Список с объектами статей, принадлежащих этой директории

Формат объекта статьи
id	int	число	ID статьи
directory_id	int	число	ID директории, к которой принадлежит статья
title	str	строка	Название статьи
created	str	строка	Дата и время создания статьи в формате ISO
edited	str	строка	Дата и время последнего редактирования статьи в формате ISO
type	str	строка	Тип объекта	"article"

Возвращает (НЕ УСПЕШНО)	Тип		Описание
error	str	строка	Описание ошибки

Примеры

Примеры использования
POSTMAN
Python	Вызов	base_url = 'https://articles.it-solution.ru/extapi/' token = 'ваш токен для интеграции' method = f'directory.structure/' response = requests.post(base_url + method, json={ 'token': token, }).json()
Результат	{ "structure": [ { "id": 1, "parent_id": null, "name": "База знаний", "created": "2024-08-21T15:55:59.029Z", "edited": "2024-08-21T15:55:59.029Z", "type": "directory", "articles": [ { "id": 1, "directory_id": 1, "title": "Тестовая статья 1", "created": "2024-08-21T15:55:59.229Z", "edited": "2024-10-30T13:45:50.169Z", "type": "article" } ], "directories": [ { "id": 2, "parent_id": 1, "name": "Тестовая директория", "created": "2024-08-21T15:55:59.092Z", "edited": "2024-10-30T13:51:06.182Z", "type": "directory", "articles": [ { "id": 2, "directory_id": 2, "title": "Тестовая статья 2", "created": "2024-10-30T13:51:48.737Z", "edited": "2024-10-30T13:51:48.753Z", "type": "article" } ], "directories": [] } ] } ] }

Примеры использования

POSTMAN

Python

Вызов

base_url = 'https://articles.it-solution.ru/extapi/'
token = 'ваш токен для интеграции'
method = f'directory.structure/'
response = requests.post(base_url + method,
                         json={
                             'token': token,
                         }).json()

Результат

{
    "structure": [
        {
            "id": 1,
            "parent_id": null,
            "name": "База знаний",
            "created": "2024-08-21T15:55:59.029Z",
            "edited": "2024-08-21T15:55:59.029Z",
            "type": "directory",
            "articles": [
                {
                    "id": 1,
                    "directory_id": 1,
                    "title": "Тестовая статья 1",
                    "created": "2024-08-21T15:55:59.229Z",
                    "edited": "2024-10-30T13:45:50.169Z",
                    "type": "article"
                }
            ],
            "directories": [
                {
                    "id": 2,
                    "parent_id": 1,
                    "name": "Тестовая директория",
                    "created": "2024-08-21T15:55:59.092Z",
                    "edited": "2024-10-30T13:51:06.182Z",
                    "type": "directory",
                    "articles": [
                        {
                            "id": 2,
                            "directory_id": 2,
                            "title": "Тестовая статья 2",
                            "created": "2024-10-30T13:51:48.737Z",
                            "edited": "2024-10-30T13:51:48.753Z",
                            "type": "article"
                        }
                    ],
                    "directories": []
                }
            ]
        }
    ]
}