метод REST scope: biconnector

biconnector.dataset.add

Создать датасет

Кто может выполнять: пользователь с доступом к разделу «Рабочее место аналитика»

Описание

Метод biconnector.dataset.add создает новый датасет, связанный с источником данных.

Параметры

fields object обязательный

Объект, содержащий данные для создания нового датасета. Формат объекта:

{
    "field_1": "value_1",
    "field_2": "value_2",
    ...,
    "field_n": "value_n"
}
  • field_n — название поля
  • value_n — значение поля

Подробное описание ниже

Параметр fields

name string обязательный

Название датасета. Название должно начинаться с буквы, можно использовать только строчные латинские буквы a-z, цифры и знак _. Максимальная длина названия 230 символа

externalName string обязательный

Название датасета во внешнем источнике, в приложении

externalCode string обязательный

Уникальный код датасета во внешнем источнике, используется при выборке данных

sourceId integer обязательный

Идентификатор источника, можно получить методами biconnector.source.list или biconnector.source.add

description string необязательный

Описание датасета

fields array обязательный

Список полей датасета, (Подробное описание)

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "fields": {
        "sourceId": 3,
        "name": "rest_dataset",
        "externalName": "extranalName",
        "externalCode": "extrnalCode",
        "description": "Описание датасета",
        "fields": [
            { "type": "int", "name": "ID", "externalCode": "ID" },
            { "type": "string", "name": "NAME", "externalCode": "NAME" },
            { "type": "string", "name": "SURNAME", "externalCode": "SURNAME" },
            { "type": "double", "name": "SCORE", "externalCode": "SCORE" },
            { "type": "date", "name": "DATA", "externalCode": "DATA" },
            { "type": "datetime", "name": "TIME", "externalCode": "TIME" }
        ]
    }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.dataset.add

Ответ

HTTP-статус: 200

{
    "result": {
      "id": 10
    },
    "time": {
        "start": 1725013197.635808,
        "finish": 1725013198.580873,
        "duration": 0.9450650215148926,
        "processing": 0.6822988986968994,
        "date_start": "2024-08-30T12:19:57+02:00",
        "date_finish": "2024-08-30T12:19:58+02:00",
        "operating": 0
    }
}

Возвращаемые данные

result object

Корневой элемент ответа. Содержит поле id с идентификатором созданного датасета

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 200

{
    "error": "VALIDATION_FIELDS_NOT_PROVIDED",
    "error_description": "Fields not provided."
}
Код Описание Значение
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. Источник не найден
DATASET_ALREADY_EXIST Dataset with this name already exists. Датасет с таким именем уже существует
VALIDATION_DATASET_NAME_INVALID Dataset name has to start with a lowercase Latin character. Possible entry includes lowercase Latin characters (a-z), numbers (0-9) and underscores. Неправильный формат названия датасета. Название должно начинаться с буквы, можно использовать только строчные латинские буквы (a-z), цифры и знак _
VALIDATION_DATASET_NAME_TOO_LONG Dataset name must not exceed 230 characters. Название датасета не должно превышать 230 символов
VALIDATION_DUPLICATE_FIELD_CODE Duplicate values found in the "code" parameter: #LIST_CODES# Обнаружены дубликаты в параметре externalCode полей датасета
VALIDATION_DUPLICATE_FIELD_NAME Duplicate values found in the "name" parameter: #LIST_NAMES# Обнаружены дубликаты в параметре name полей датасета
VALIDATION_FIELD_MISSING_REQUIRED_PARAMETERS Field must include the required parameters: "name", "externalCode" and "type". Поле должно включать параметры name, externalCode и type
VALIDATION_FIELD_NAME_INVALID_FORMAT Field "name" has to start with an uppercase Latin character. Possible entry includes uppercase Latin characters (A-Z), numbers (0-9) and underscores. Неправильный формат названия поля. Название должно начинаться с буквы, можно использовать только заглавные латинские буквы (A-Z), цифры и знак _
VALIDATION_FIELD_NAME_TOO_LONG Field "name" must not exceed 32 characters. Название поля не должно превышать 32 символов
VALIDATION_FIELD_INVALID_TYPE Invalid field type. Некорректный тип поля
Error adding dataset Ошибка добавления датасета

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.