метод REST scope: biconnector

biconnector.dataset.update

Обновить датасет

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

Описание

Метод biconnector.dataset.update обновляет существующий датасет.

Параметры

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

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

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

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

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

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

Параметр fields

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "id": 10,
    "fields": {
        "description": "Новое описание"
    }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.dataset.update

Ответ

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# Обнаружены неизвестные параметры: #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#
DATASET_NOT_FOUND Dataset was not found. Датасет не найден
INVALID_METHOD Use the method "biconnector.dataset.fields.update" to update the dataset fields. Для обновления полей используйте метод biconnector.dataset.fields.update
Error updating dataset. Ошибка обновления датасета

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

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