DAX-БУС. Обмен. V2.0. Техническое задание на расширения RestApi в Битрикс Управление Сайтом. 4 Общая информация 4 Модуль symmetron restapi 5

• Название: Техническое задание на расширения RestApi в Битрикс Управление Сайтом. 4 Общая информация 4 Модуль symmetron restapi 5
• Дата: 29.01.2022
• Размер: 74.23 Kb.
• Имя файла: DAX-БУС. Обмен. V2.0.docx
• Тип: Техническое задание; #345558
• страница: 2 из 8

Страницы для создания вебхуков.

Необходимо создать страницы, которые будут доступны только пользователям, который находятся в группе администраторы.

На данных страницах необходимо разместить стандартные компоненты битрикса, которые позволяют:

• 
  Просмотреть список существующих вебхуков системы
  
• 
  Создать вебхук и настроить для него scopes
  
• 
  Изменить вебхук и настроить для него scopes
  
• 
  Удалить вебхук
  
• 
  Просмотр статистики запросов
  

Весь функционал этих компонентов работает по стандартным правилам

Форматы ответов

Успех

В случае, если запрос проведен успешно, то он должен вернуть данные в стандартном формате RestApi Bitrix

Array

(

[result] => Array

(

Данные ответа

)

[total] => 2387743

[time] => Array

(

[start] => 1581607213.4833

[finish] => 1581607263.3997

[duration] => 49.916450023651

[processing] => 49.899916887283

[date_start] => 2020-02-13T18:20:13+03:00

[date_finish] => 2020-02-13T18:21:03+03:00

)

)

Где,

Result – результат выполнения запроса

Total – количество элементов всего (только для списочных элементов)

Time – массив данных о времени запроса
Ошибка



Если при выполнении запроса произошла ошибка, то он должен вернуть данные в стандартном формате RestApi Bitrix

{

"error": "METHOD_CONFIRM_DENIED",

"error_description": "Method call denied"

}

где,

error – код ошибки

error_description – текст ошибки

Описание методов и структуры данных

Структура полей для разделов ИБ

Стандартные поля раздела ИБ, которые участвуют в RestApi

ID	ID раздела ИБ.
CODE	Символьный идентификатор.
EXTERNAL_ID или XML_ID	Внешний код.
IBLOCK_ID	ID ИБ.
IBLOCK_SECTION_ID	ID раздела родителя, если не задан, то группа корневая.
TIMESTAMP_X	Дата последнего изменения параметров группы.
SORT	Порядок сортировки (среди групп внутри одной группы-родителя).
NAME	Наименование группы.
ACTIVE	Флаг активности (Y|N)
GLOBAL_ACTIVE	Флаг активности, учитывая активность вышележащих (родительских) групп (Y|N). Вычисляется автоматически (не может быть изменен вручную).
PICTURE	ID картинки в таблице файлов
DESCRIPTION	Описание раздела.
DESCRIPTION_TYPE	Тип описания группы (text/html).
DEPTH_LEVEL	Уровень вложенности группы. Вычисляется автоматически (не устанавливается вручную).
SEARCHABLE_CONTENT	Содержимое для поиска при фильтрации групп. Вычисляется автоматически. Складывается из полей NAME и DESCRIPTION (без html тэгов, если DESCRIPTION_TYPE установлен в html).
MODIFIED_BY	Код пользователя, в последний раз изменившего элемент.
DATE_CREATE	Дата создания элемента.
CREATED_BY	Код пользователя, создавшего элемент.
DETAIL_PICTURE	ID картинки в таблице файлов для детального просмотра.

Так же в разделе ИБ могут присутствовать дополнительные пользовательские поля различного типа. Коды данных полей начинаются с префикса UF