метод REST scope: biconnector

biconnector.source.update

Изменить источник

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

Описание

Метод biconnector.source.update обновляет существующий источник.

Параметры

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

Идентификатор источника, можно получить методами biconnector.source.list и 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 необязательный

Активность источника

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "id": 4,
    "fields": {
        "title": "Новое название источника",
        "description": "Обновленное описание источника",
        "active": false,
        "settings": {
            "login": "new_admin",
            "password": "new_password"
        }
    }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.source.update

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1725365418.056843,
        "finish": 1725365419.671506,
        "duration": 1.6146628856658936,
        "processing": 1.3475170135498047,
        "date_start": "2024-09-03T14:10:18+02:00",
        "date_finish": "2024-09-03T14:10:19+02:00"
    }
}

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

result boolean

Корневой элемент ответа, содержит true в случае успеха

time time

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

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

HTTP-статус: 200

{
    "error": "VALIDATION_FIELDS_NOT_PROVIDED",
    "error_description": "Fields not provided."
}
Код Описание Значение
VALIDATION_ID_NOT_PROVIDED ID is missing. Идентификатор не указан
VALIDATION_INVALID_ID_FORMAT ID has to be a positive integer. Неверный формат ID
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#
SOURCE_NOT_FOUND Source 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. Нельзя удалить источник, пока существуют связанные датасеты

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

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