Изменить коннектор biconnector.connector.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
biconnectorКто может выполнять метод: пользователь с доступом к разделу «Рабочее место аналитика»
Метод biconnector.connector.update обновляет существующий коннектор.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор коннектора, можно получить методами biconnector.connector.list и biconnector.connector.add |
|
fields* |
Объект, содержащий обновляемые данные. Формат объекта:
|
Параметр fields
|
Название |
Описание |
|
title |
Новое название коннектора |
|
logo |
Новый логотип коннектора. Может передаваться ссылкой на изображение или строкой формата base64, например |
|
description |
Новое описание коннектора |
|
urlCheck |
Новый эндпоинт для проверки доступности коннектора, (подробное описание) |
|
urlTableList |
Новый эндпоинт для получения списка таблиц, (подробное описание) |
|
urlTableDescription |
Новый эндпоинт для получения описания конкретной таблицы, (подробное описание) |
|
urlData |
Новый эндпоинт для получения данных по выбранной таблице, (подробное описание) |
|
settings |
Новый список параметров подключения, (подробное описание) |
|
sort |
Новый параметр сортировки коннектора |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 4,
"fields": {
"title": "UPDATED REST CONNECTOR",
"logo": "data:image/svg+xml;base64,NEWLOGODATA",
"description": "Updated description",
"urlCheck": "http://example.com/api/new_check",
"urlTableList": "http://example.com/api/new_table_list",
"urlTableDescription": "http://example.com/api/new_table_description",
"urlData": "http://example.com/api/new_data",
"settings": [
{
"name": "Идентификатор сотрудника",
"type": "STRING",
"code": "id"
},
{
"name": "Пароль",
"type": "STRING",
"code": "password"
}
],
"sort": 200
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.connector.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 4,
"fields": {
"title": "UPDATED REST CONNECTOR",
"logo": "data:image/svg+xml;base64,NEWLOGODATA",
"description": "Updated description",
"urlCheck": "http://example.com/api/new_check",
"urlTableList": "http://example.com/api/new_table_list",
"urlTableDescription": "http://example.com/api/new_table_description",
"urlData": "http://example.com/api/new_data",
"settings": [
{
"name": "Идентификатор сотрудника",
"type": "STRING",
"code": "id"
},
{
"name": "Пароль",
"type": "STRING",
"code": "password"
}
],
"sort": 200
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.connector.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'biconnector.connector.update',
params: {
id: 4,
fields: {
title: 'UPDATED REST CONNECTOR',
logo: 'data:image/svg+xml;base64,NEWLOGODATA',
description: 'Updated description',
urlCheck: 'http://example.com/api/new_check',
urlTableList: 'http://example.com/api/new_table_list',
urlTableDescription: 'http://example.com/api/new_table_description',
urlData: 'http://example.com/api/new_data',
settings: [
{
name: 'Employee ID',
type: 'STRING',
code: 'id',
},
{
name: 'Password',
type: 'STRING',
code: 'password',
},
],
sort: 200,
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Connector updated:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateConnector() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.connector.update',
params: {
id: 4,
fields: {
title: 'UPDATED REST CONNECTOR',
logo: 'data:image/svg+xml;base64,NEWLOGODATA',
description: 'Updated description',
urlCheck: 'http://example.com/api/new_check',
urlTableList: 'http://example.com/api/new_table_list',
urlTableDescription: 'http://example.com/api/new_table_description',
urlData: 'http://example.com/api/new_data',
settings: [
{
name: 'Employee ID',
type: 'STRING',
code: 'id',
},
{
name: 'Password',
type: 'STRING',
code: 'password',
},
],
sort: 200,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Connector updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateConnector)
</script>
try {
$response = $b24Service
->core
->call(
'biconnector.connector.update',
[
'id' => 4,
'fields' => [
"title" => "UPDATED REST CONNECTOR",
"logo" => "data:image/svg+xml;base64,NEWLOGODATA",
"description" => "Updated description",
"urlCheck" => "http://example.com/api/new_check",
"urlTableList" => "http://example.com/api/new_table_list",
"urlTableDescription" => "http://example.com/api/new_table_description",
"urlData" => "http://example.com/api/new_data",
"settings" => [
[
"name" => "Идентификатор сотрудника",
"type" => "STRING",
"code" => "id"
],
[
"name" => "Пароль",
"type" => "STRING",
"code" => "password"
]
],
"sort" => 200
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating connector: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.connector.update',
{
id: 4,
fields: {
"title": "UPDATED REST CONNECTOR",
"logo": "data:image/svg+xml;base64,NEWLOGODATA",
"description": "Updated description",
"urlCheck": "http://example.com/api/new_check",
"urlTableList": "http://example.com/api/new_table_list",
"urlTableDescription": "http://example.com/api/new_table_description",
"urlData": "http://example.com/api/new_data",
"settings": [
{
"name": "Идентификатор сотрудника",
"type": "STRING",
"code": "id"
},
{
"name": "Пароль",
"type": "STRING",
"code": "password"
}
],
"sort": 200
}
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.connector.update',
[
'id' => 4,
'fields' => [
'title' => 'UPDATED REST CONNECTOR',
'logo' => 'data:image/svg+xml;base64,NEWLOGODATA',
'description' => 'Updated description',
'urlCheck' => 'http://example.com/api/new_check',
'urlTableList' => 'http://example.com/api/new_table_list',
'urlTableDescription' => 'http://example.com/api/new_table_description',
'urlData' => 'http://example.com/api/new_data',
'settings' => [
[
'name' => 'Идентификатор сотрудника',
'type' => 'STRING',
'code' => 'id'
],
[
'name' => 'Пароль',
'type' => 'STRING',
'code' => 'password'
]
],
'sort' => 200
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "biconnector.connector.update", b24.Params{
"id": 4,
"fields": b24.Params{
"title": "UPDATED REST CONNECTOR",
"logo": "data:image/svg+xml;base64,NEWLOGODATA",
"description": "Updated description",
"urlCheck": "http://example.com/api/new_check",
"urlTableList": "http://example.com/api/new_table_list",
"urlTableDescription": "http://example.com/api/new_table_description",
"urlData": "http://example.com/api/new_data",
"settings": []b24.Params{
{
"name": "Идентификатор сотрудника",
"type": "STRING",
"code": "id",
},
{
"name": "Пароль",
"type": "STRING",
"code": "password",
},
},
"sort": 200,
},
})
if err != nil {
return fmt.Errorf("biconnector.connector.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Обработка ответа
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 |
Корневой элемент ответа, содержит |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 200
{
"error": "VALIDATION_FIELDS_NOT_PROVIDED",
"error_description": "Fields not provided."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
ID is missing. |
Идентификатор не указан |
|
|
ID has to be a positive integer. |
Неверный формат ID |
|
|
Fields not provided. |
Поля не переданы в запросе |
|
|
Unknown parameters: #LIST_OF_PARAMS# |
Обнаружены неизвестные параметры: перечень |
|
|
Field "#TITLE#" is read only. |
Поле #TITLE# доступно только для чтения и не может быть изменено |
|
|
Field "#TITLE#" is immutable. |
Поле #TITLE# неизменяемое |
|
|
Field "#TITLE#" must be of type #TYPE#. |
Поле #TITLE# должно быть типа #TYPE# |
|
|
Connector was not found. |
Коннектор не найден |
|
|
Settings must include "type", "name" and "code" fields. |
В настройках должны быть указаны поля |
|
|
Parameter "type" is not correct. |
Недопустимое значение параметра |
|
|
Parameter "name" must be less than 512 characters. |
Значение параметра |
|
|
Parameter "code" must be less than 512 characters. |
Значение параметра |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |