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
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"
}
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.source.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.source.update',
params: {
id: 4,
fields: {
title: 'New source title',
description: 'Updated source description',
active: false,
settings: {
login: 'new_admin',
password: 'new_password',
},
},
},
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('Source 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 updateSource() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.source.update',
params: {
id: 4,
fields: {
title: 'New source title',
description: 'Updated source description',
active: false,
settings: {
login: 'new_admin',
password: 'new_password',
},
},
},
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('Source updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateSource)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.source.update(
bitrix_id=4,
fields={
"title": "New source title",
"description": "Updated source description",
"active": False,
"settings": {
"login": "new_admin",
"password": "new_password",
},
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'biconnector.source.update',
[
'id' => 4,
'fields' => [
"title" => "Новое название источника",
"description" => "Обновленное описание источника",
"active" => false,
"settings" => [
"login" => "new_admin",
"password" => "new_password"
]
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating source: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.source.update',
{
id: 4,
fields: {
"title": "Новое название источника",
"description": "Обновленное описание источника",
"active": false,
"settings": {
"login": "new_admin",
"password": "new_password"
}
}
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.source.update',
[
'id' => 4,
'fields' => [
'title' => 'Новое название источника',
'description' => 'Обновленное описание источника',
'active' => false,
'settings' => [
'login' => 'new_admin',
'password' => 'new_password'
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "biconnector.source.update", b24.Params{
"id": 4,
"fields": b24.Params{
"title": "Новое название источника",
"description": "Обновленное описание источника",
"active": false,
"settings": b24.Params{
"login": "new_admin",
"password": "new_password",
},
},
})
if err != nil {
return fmt.Errorf("biconnector.source.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
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. | Нельзя удалить источник, пока существуют связанные датасеты |

