article.get

Оглавление

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

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

Метод article.get получает информацию о статье по ID

О Методе

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

Параметры

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

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

Возвращает (УСПЕШНО)	Тип		Описание
tags	str	строка	Теги
readers	list	список	Кто может читать статью	type - тип str - строка: Тип (пользователь/отдел/группа). "all" если доступ не ограничен. id - тип int - число: ID (пользователя/отдела/группы). name - тип str - строка: Имя (пользователя/отдела/группы). extranet - тип bool - логическое значение: Является Экстранетом.
editors	list	список	Кто может изменять статью	type - тип str - строка: Тип (пользователь/отдел/группа). "all" если доступ не ограничен. id - тип int - число: ID (пользователя/отдела/группы). name - тип str - строка: Имя (пользователя/отдела/группы). extranet - тип bool - логическое значение: Является Экстранетом.
custom_access	bool	логическое значение	Индивидуальная настройка доступа
read_access	list	список	Список кодов групп Битрикс, которым даны права на чтение статьи
edit_access	list	список	Список кодов групп Битрикс, которым даны права на редактирование статьи
public_url	str	строка	URL ссылка на опубликованную статью
is_favorite	bool	логическое значение	В избранном
is_subscribed	bool	логическое значение	У собственника токена есть подписка на уведомления на эту статью
can_edit	bool	логическое значение	У собственника токена нет доступа на редактирование статьи
id	int	число	ID статьи, которую получаем
user			id - тип int - число: ID автора на портале Битрикс. kdb_id - тип id - число: ID автора в Базе Знаний. name - тип str - строка: Имя автора. extranet - тип bool - логическое значение: Является Экстранетом.
title	str	строка	Наименование статьи
public	bool	логическое значение	Статья Опубликована
rendered_body	str	строка	Тело статьи
directory_id	int	число	ID раздела
external_id	uuid	всемирно уникальный идентификатор	Всемирно уникальный идентификатор Локальной Статьи
link_to_id	int	число	Ссылка на статью которая является основой, если это статья-ссылка
post_id
sort	int	число	Сортировка
froala	bool	логическое значение	Текст в формате Froala (Всегда true)
plain_text	bool	логическое значение	Текст в формате Plain Text (простой текст)
created	str	строка	Дата и время создания
edited	str	строка	Дата и время последнего изменения
call_placement	bool	логическое значение	Встроена в карточку звонка

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

Примеры

Примеры использования
POSTMAN
Python	Вызов	base_url = 'https://articles.it-solution.ru/extapi/' token = 'ваш токен для интеграции' method = 'article.get/' response = requests.get(base_url + method, params={ 'token': token, 'id': 1, }).json()
Результат	{ "tags": [], "readers": [{"type": "all"}], "editors": [], "custom_access": false, "read_access": ["U-180608","U2727","UA"], "edit_access": [], "public_url": null, "is_favorite": false, "is_subscribed": true, "can_edit": true, "user": { "id": 1212, "kdb_id": 184216, "name": "Иван Иванов", "extranet": false }, "id": 1, "user_id": 184216, "title": "Наименование статьи", "public": false, "rendered_body": "<p>Тело (текст) статьи</p>", "directory_id": 2, "link_to_id": null, "external_id": null, "post_id": "", "sort": 500, "froala": true, "plain_text": false, "created": "2024-09-09T10:45:18.271Z", "edited": "2024-09-09T10:45:18.365Z", "call_placement": false }

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

POSTMAN

Python

Вызов

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

Результат

{
    "tags": [],
    "readers": [{"type": "all"}],
    "editors": [],
    "custom_access": false,
    "read_access": ["U-180608","U2727","UA"],
    "edit_access": [],
    "public_url": null,
    "is_favorite": false,
    "is_subscribed": true,
    "can_edit": true,
    "user": {
        "id": 1212,
        "kdb_id": 184216,
        "name": "Иван Иванов",
        "extranet": false
    },
    "id": 1,
    "user_id": 184216,
    "title": "Наименование статьи",
    "public": false,
    "rendered_body": "<p>Тело (текст) статьи</p>",
    "directory_id": 2,
    "link_to_id": null,
    "external_id": null,
    "post_id": "",
    "sort": 500,
    "froala": true,
    "plain_text": false,
    "created": "2024-09-09T10:45:18.271Z",
    "edited": "2024-09-09T10:45:18.365Z",
    "call_placement": false
}