метод REST scope: biconnector

biconnector.source.add

Создать источник

Кто может выполнять: пользователь с доступом к разделу «Рабочее место аналитика»

Описание

Метод biconnector.source.add создает новый источник данных, связанный с коннектором.

Параметры

fields object обязательный

Объект, содержащий данные для создания нового источника. Формат объекта:

{
    "field_1": "value_1",
    "field_2": "value_2",
    ...,
    "field_n": "value_n"
}
  • field_n — название поля
  • value_n — значение поля

Подробное описание ниже

Параметр fields

title string обязательный

Название источника

description string необязательный

Описание источника

active boolean необязательный

Активность источника.
По умолчанию true

connectorId integer обязательный

Идентификатор коннектора, можно получить методами biconnector.connector.list или biconnector.connector.add

settings object обязательный

Список параметров для авторизации, передается объектом, где ключ — code параметра.
Параметры можно получить методами biconnector.connector.list или biconnector.connector.get

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"CRM Source","description":"Источник данных CRM","connectorId":123,"settings":{"login":"admin","password":"qwerty"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.source.add

Ответ

HTTP-статус: 200

{
    "result": {
      "id": 7
    },
    "time": {
        "start": 1725013197.635808,
        "finish": 1725013198.580873,
        "duration": 0.9450650215148926,
        "processing": 0.6822988986968994,
        "date_start": "2024-08-30T12:19:57+02:00",
        "date_finish": "2024-08-30T12:19:58+02:00",
        "operating": 0
    }
}

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

result object

Корневой элемент ответа. Содержит поле id с идентификатором созданного источника

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 200

{
    "error": "VALIDATION_FIELDS_NOT_PROVIDED",
    "error_description": "Fields not provided."
}
Код Описание Значение
VALIDATION_FIELDS_NOT_PROVIDED Fields not provided. Поля не переданы в запросе
VALIDATION_UNKNOWN_PARAMETERS Unknown parameters: #LIST_OF_PARAMS# Обнаружены неизвестные параметры: перечень
VALIDATION_REQUIRED_FIELD_MISSING Field "#TITLE#" is required. Обязательное поле #TITLE# не передано
VALIDATION_READ_ONLY_FIELD Field "#TITLE#" is read only. Поле #TITLE# доступно только для чтения и не может быть изменено
VALIDATION_IMMUTABLE_FIELD Field "#TITLE#" is immutable. Поле #TITLE# неизменяемое
VALIDATION_INVALID_FIELD_TYPE Field "#TITLE#" must be of type #TYPE#. Поле #TITLE# должно быть типа #TYPE#
CONNECTOR_NOT_FOUND Connector was not found. Коннектор не найден
SOURCE_CREATE_CONNECTION_ERROR Cannot create connection. Ошибка при создании подключения
SOURCE_UPDATE_CONNECTION_ERROR Cannot update connection. Ошибка при обновлении подключения
BX_ERROR Cannot delete source. Delete all related datasets first. Нельзя удалить источник, пока существуют связанные датасеты

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.