Update Dataset Fields biconnector.dataset.fields.update
Scope:
biconnectorWho can execute the method: user with access to the "Analyst's workspace" section
The method biconnector.dataset.fields.update updates the fields of an existing dataset.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the dataset, can be obtained using the methods biconnector.dataset.list or biconnector.dataset.add |
|
add |
Object containing an array of fields to be added with the following structure:
|
|
update |
Object containing an array of fields to be updated with the following structure:
|
|
delete |
Object containing an array of field identifiers for deletion. Field identifiers can be obtained using the method biconnector.dataset.get |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 10,
"add": [
{
"type": "int",
"name": "NAME",
"externalCode": "NAME"
},
{
"type": "int",
"name": "ID",
"externalCode": "ID"
}
],
"update": [
{
"id": 12,
"visible": false
},
{
"id": 13,
"visible": true
}
],
"delete": [
14,
15
]
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.dataset.fields.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 10,
"add": [
{
"type": "int",
"name": "NAME",
"externalCode": "NAME"
},
{
"type": "int",
"name": "ID",
"externalCode": "ID"
}
],
"update": [
{
"id": 12,
"visible": false
},
{
"id": 13,
"visible": true
}
],
"delete": [
14,
15
],
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.dataset.fields.update
try
{
const response = await $b24.callMethod(
'biconnector.dataset.fields.update',
{
id: 10,
add: [
{
type: "int",
name: "NAME",
externalCode: "NAME"
},
{
type: "int",
name: "ID",
externalCode: "ID"
}
],
update: [
{
"id": 12,
"visible": false
},
{
"id": 13,
"visible": true
}
],
delete: [
14,
15
]
}
);
const result = response.getData().result;
result.error()
? console.error(result.error())
: console.info(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'biconnector.dataset.fields.update',
[
'id' => 10,
'add' => [
[
'type' => "int",
'name' => "NAME",
'externalCode' => "NAME"
],
[
'type' => "int",
'name' => "ID",
'externalCode' => "ID"
]
],
'update' => [
[
'id' => 12,
'visible' => false
],
[
'id' => 13,
'visible' => true
]
],
'delete' => [14, 15]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating dataset fields: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.dataset.fields.update',
{
id: 10,
add: [
{
type: "int",
name: "NAME",
externalCode: "NAME"
},
{
type: "int",
name: "ID",
externalCode: "ID"
}
],
update: [
{
"id": 12,
"visible": false
},
{
"id": 13,
"visible": true
}
],
delete: [
14,
15
]
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.dataset.fields.update',
[
'id' => 10,
'add' => [
[
'type' => 'int',
'name' => 'NAME',
'externalCode' => 'NAME'
],
[
'type' => 'int',
'name' => 'ID',
'externalCode' => 'ID'
]
],
'update' => [
[
'id' => 12,
'visible' => false
],
[
'id' => 13,
'visible' => true
]
],
'delete' => [14, 15]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 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"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response, contains |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 200
{
"error": "VALIDATION_ID_NOT_PROVIDED",
"error_description": "ID is missing."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
ID is missing. |
Identifier is not specified |
|
|
ID has to be a positive integer. |
Invalid ID format |
|
|
Dataset was not found. |
Dataset not found |
|
|
Error updating dataset. |
Error updating dataset |
|
|
Duplicate values found in the "code" parameter: #LIST_CODES# |
Duplicates found in the |
|
|
Duplicate values found in the "name" parameter: #LIST_NAMES# |
Duplicates found in the |
|
|
Field "name" has to start with an uppercase Latin character. Possible entry includes uppercase Latin characters (A-Z), numbers (0-9) and underscores. |
Incorrect field name format. The name must start with a letter, only uppercase Latin letters |
|
|
Field "name" must not exceed 32 characters. |
Field name must not exceed 32 characters |
|
|
Invalid field type. |
Incorrect field type |
|
|
The following "externalCode" values already exist in the current fields: #LIST_CODES# |
Fields with this |
|
|
The following "name" values already exist in the current fields: #LIST_NAMES# |
Fields with this |
|
|
Field to be added must include the required parameters: "name", "externalCode" and "type". |
Field to be added must include |
|
|
Field to be updated must include the required parameters: "id" and "visible". |
Field to be updated must include |
|
|
ID to be deleted must be a positive integer. |
Invalid |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create Dataset biconnector.dataset.add
- Update Dataset biconnector.dataset.update
- Get Fields of the Dataset biconnector.dataset.fields
- Get dataset by id biconnector.dataset.get
- Get the list of datasets biconnector.dataset.list
- Delete dataset biconnector.dataset.delete