Sources: Overview of Methods

A source is a separate connection to an external system in the BIconnector module. The source defines which specific data from the external system will be available for use in reports and analytics in Bitrix24.

Quick navigation: all methods

Connection of the Source with the Connector and DatasetsConnection of the Source with the Connector and Datasets

The source is registered through the connector. In the hierarchy of the BIconnector module, sources occupy an intermediate level:

• Connector establishes a connection with the external data source.
• Source defines the access parameters for the data.
• Dataset forms the final set of data that can be used in reports and analytics.

Description of Source FieldsDescription of Source Fields

Name type	Description	Read	Write
id integer	Unique identifier of the source	✅	❌
title string	Name of the source	✅	✅
type string	Type of the source, value is always rest	✅	❌
code string	Code of the source, system field	✅	❌
description string	Description of the source	✅	✅
active boolean	Status of the source's activity	✅	✅
dateCreate datetime	Creation date of the source	✅	❌
dateUpdate datetime	Update date of the source	✅	❌
createdById integer	Identifier of the user who created the source	✅	❌
updatedById integer	Identifier of the user who updated the source	✅	❌
connectorId integer	Identifier of the connector to which the source is linked	✅	✅
settings array	List of authorization parameters	✅	✅

Field settingsField settings

The settings field contains a list of parameters for authorization through the connector. The parameters are passed in the format of an object, where the key is the parameter identifier — code. The values of code can be obtained using the methods biconnector.connector.list or biconnector.connector.get.

Overview of MethodsOverview of Methods

Scope: biconnector

Who can execute the methods: a user with access to the "Analyst Workspace" section

Method	Description
biconnector.source.add	Adds a new source
biconnector.source.update	Updates an existing source
biconnector.source.get	Returns information about the source
biconnector.source.list	Returns a list of available sources
biconnector.source.delete	Deletes a source
biconnector.source.fields	Returns the description of the source fields