Datasets: Overview of Methods

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

A dataset is an object of the BIconnector module. Datasets are used to display and process information in Bitrix24 obtained from sources.

Quick navigation: all methods

Methods work only in the context of the application

Connection of Dataset with Connector and Sources

A dataset is the final level in the hierarchy of data handling in the BIconnector module:

  • Connector establishes a connection with an external data source.
  • Source defines which specific data is available from the connected service.
  • Dataset forms the final set of data that can be used in reports and analytics.

Description of Dataset Fields

Name
type

Description

Read

Write

id
integer

Unique identifier of the dataset

✅

❌

type
string

Type of the dataset, the value is always rest

✅

❌

name
string

Name of the dataset

✅

✅

description
string

Description of the dataset

✅

✅

externalCode
string

External code of the dataset

✅

✅

externalName
string

External name of the dataset

✅

✅

dateCreate
datetime

Creation date of the dataset

✅

❌

dateUpdate
datetime

Update date of the dataset

✅

❌

createdById
integer

Identifier of the user who created the dataset

✅

❌

updatedById
integer

Identifier of the user who updated the dataset

✅

❌

externalId
integer

External identifier of the dataset

✅

❌

fields
array

List of fields included in the dataset

✅

✅

Description of the Fields Field

Name
type

Description

Read

Write

id
integer

Identifier of the field

✅

❌

datasetId
integer

Identifier of the dataset to which the field belongs

✅

✅

type
string

Data type. Available types:
int — integer
string — string
double — decimal number, separator is a dot
date — date, format Y-m-d
datetime — date with time, format Y-m-d H:i:s

✅

✅

name
string

Name of the field. The name must start with a letter and can only use uppercase Latin letters A-Z, digits, and the _ sign. The maximum length of the name is 32 characters

✅

✅

externalCode
string

External code of the field

✅

✅

visible
boolean

Field visibility flag

✅

✅

Overview of Methods

Scope: biconnector

Who can perform methods: a user with access to the "Analyst's Workspace" section

Method

Description

biconnector.dataset.add

Adds a new dataset

biconnector.dataset.update

Updates an existing dataset

biconnector.dataset.fields.update

Updates the fields of the dataset

biconnector.dataset.get

Returns information about the dataset

biconnector.dataset.list

Returns a list of available datasets

biconnector.dataset.delete

Deletes a dataset

biconnector.dataset.fields

Returns the description of the dataset fields
Previous
Get source fields
Next
Create dataset