метод REST scope: biconnector

biconnector.dataset.fields.update

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

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

Описание

Метод biconnector.dataset.fields.update обновляет поля существующего датасета.

Параметры

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

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

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

Объект, содержащий массив добавляемых полей со следующей структурой:

{
    "type" : "int",
    "name": "NAME",
    "externalCode":"NAME"
},
  • type — тип поля
  • name — название поля
  • externalCode — внешний код поля
update object необязательный

Объект, содержащий массив обновляемых полей со следующей структурой:

{
    "id": 12,
    "visible": false
},
  • id — Идентификатор поля, можно получить методом biconnector.dataset.get
  • visible — видимость поля
delete integer[] необязательный

Объект, содержащий массив идентификаторов полей для их удаления. Идентификаторы полей можно получить методом biconnector.dataset.get

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

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

Ответ

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_ID_NOT_PROVIDED",
    "error_description": "ID is missing."
}
Код Описание Значение
VALIDATION_ID_NOT_PROVIDED ID is missing. Идентификатор не указан
VALIDATION_INVALID_ID_FORMAT ID has to be a positive integer. Неверный формат ID
DATASET_NOT_FOUND Dataset was not found. Датасет не найден
DATASET_UPDATE_ERROR Error updating dataset. Ошибка обновления датасета
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_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. Некорректный тип поля
VALIDATION_DUPLICATE_EXIST_CODE The following "externalCode" values already exist in the current fields: #LIST_CODES# Поля с таким параметром externalCode уже существуют
VALIDATION_DUPLICATE_EXIST_NAME The following "name" values already exist in the current fields: #LIST_NAMES# Поля с таким параметром name уже существуют
VALIDATION_FIELD_ADD_MISSING_REQUIRED_FIELDS Field to be added must include the required parameters: "name", "externalCode" and "type". Поле для добавления должно включать параметры name, externalCode и type
VALIDATION_FIELD_UPDATE_MISSING_REQUIRED_FIELDS Field to be updated must include the required parameters: "id" and "visible". Поле для обновления должно включать параметры id и visible
VALIDATION_FIELD_DELETE_INVALID_ID ID to be deleted must be a positive integer. Неверный формат id для удаления

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

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