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
• страница: 4 из 8

Получения списка типов ИБ

Эндпоинт метода: symmetron.iblock.types.list

Входные параметры: нет

Возвращаемые данные:

Список типов инфоблоков в формате:

{

КОД ТИПА ИНФОБЛОКА: НАЗВАНИЕ ТИПА ИНФОБЛОКА

}

Пример для сайта symmetron.ru

Запрос:

/symmetron.iblock.types.list/

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

{

‘catalog’: ‘Каталоги’,

‘catalog_parm_rules’: ’ Настройка предустановленных солбцов’,

‘documents’: ‘Библиотека документаций’

и т.д.

}

Получения списка ИБ

Эндпоинт метода: symmetron.iblock.list

Входные параметры:

IBLOCK_TYPE_ID

Код Типа ИБ

За основу взят метод CIblock::getList

Возвращаемые данные:

Список ИБ указанного типа в формате:

{

ID ИБ: {

ID : ID ИБ

CODE: Код ИБ

NAME: Название ИБ

ACTIVE: активность ИБ. Возвращается Y/N

}

}

Пример для сайта symmetron.ru

Запрос:

/symmetron.iblock.list/?IBLOCK_TYPE_ID= catalog

{

4: {

ID : 4

CODE: pbd

NAME: Основной каталог товаров

ACTIVE: Y

},

5: {

ID : 5

CODE: etalon

NAME: Эталон

ACTIVE: Y

},

10: {

ID : 10

CODE: etalon

NAME: Отраслевые решения

ACTIVE: Y

},

28: {

ID : 28

CODE: activity

NAME: Мероприятия

ACTIVE: Y

},

и т.д

}

Получение информации о ИБ по ID или CODE

Эндпоинт метода: symmetron.iblock.get

Входные параметры:

ID	ID ИБ
CODE	Код инфоблока

В данном случае может применяться любой из двух параметров для определения ИБ. В случае, если в запросе указаны оба параметра, то в приоритете ID.

Возвращаемые данные:

{

ID : ID ИБ

CODE: Код ИБ

NAME: Название ИБ

ACTIVE: активность ИБ. Возвращается Y/N

}

Пример для сайта symmetron.ru

Запрос:

/symmetron.iblock.get /?ID=4

{

ID : 4

CODE: pbd

NAME: Основной каталог товаров

ACTIVE: Y

}

Получение полей и пользовательских полей раздела ИБ

Эндпоинт метода: symmetron.iblock.section.fields

Входные параметры:

ID	ID ИБ
CODE	Код инфоблока
FIELD_CODE	Может быть одиночное значение или массив

В данном случае может применяться любой из двух параметров для определения ИБ. В случае, если в запросе указаны оба параметра, то в приоритете ID.

FIELD_CODE – если поле не заполнено, возвращаются данные о всех полях и пользовательских полях разделов инфоблока. Если указано одно или несколько значений, то возвращается информация только об указанных полях

Так же в ответе выводятся только те поля, у которых есть значение

Возвращаемые данные:

{

FIELDS:

{

Код поля: {

CODE: Код поля,

NAME: название поля

IS_REQUIRED: Y/N. Обязательное или не обязательное поле

},

},

UF:

{

ЗНАЧЕНИЕ FIELD_NAME: {

CODE: Код поля из FIELD_NAME

ENTITY_ID: код сущности к которой привязано поле

ID: ID поля/свойства – может не быть у полей

NAME: название поля/свойства,

USER_TYPE_ID: тип поля

IS_REQUIRED: Y/N. Обязательное или не обязательное поле

MULTIPLE: Y/N – множественное или одиночное поля,

SORT – сортировка - – может не быть у полей

LINK_IBLOCK_ID – id ИБ, к которому привязывается свойство

DEFAULT_VALUE – значение по умолчанию

VALUE – массив с значениями для списочного поля

}

}

}

Пример для сайта symmetron.ru

Запрос:

/symmetron.iblock.fields /?ID=4

{

FIELDS:

{

NAME:

{

CODE: NAME

NAME: Название

IS_REQUIRED: Y

},

ACTIVE:

{

CODE: ACTIVE

NAME: Активность

IS_REQUIRED: Y,

DEFAULT_VALUE: Y

}

},

PROPERTIES:

{

ARTICLES:

{

ACTIVE: Y

CODE: ARTICLES

ID: 44

NAME: Код товара у производителя

IS_REQUIRED: N

MULTIPLE: N,

SORT : 1

USER_TYPE_ID: string,

ENTITY_ID: IBLOCK_4

},

DOC_AND_FILES:

{

ACTIVE: Y

CODE: DOC_AND_FILES

ID: 3077

NAME: Документация и файлы для загрузки

IS_REQUIRED: N

MULTIPLE: Y,

SORT : 500

USER_TYPE_ID: iblock_section,

ENTITY_ID: IBLOCK_4

LINK_IBLOCK_ID: 16

},

}

И т.д

}