метод REST scope: placement

userfieldtype.add

Зарегистрировать новый тип пользовательских полей

Кто может выполнять: администратор

Описание

Метод userfieldtype.add регистрирует новый тип пользовательских полей. После регистрации типа, создайте пользовательское поле методом userfieldconfig.add.

При открытии карточки с полем пользовательского типа на обработчик приложения передается массив PLACEMENT_OPTIONS с данными о поле и элементе.

{
    "MODE": "view",
    "ENTITY_ID": "CRM_DEAL",
    "FIELD_NAME": "UF_CRM_TEST_TYPE_1",
    "ENTITY_VALUE_ID": "7303",
    "VALUE": null,
    "MULTIPLE": "N",
    "MANDATORY": "N",
    "XML_ID": null,
    "ENTITY_DATA": {
        "entityTypeId": 2,
        "entityId": "7303",
        "module": "crm"
    }
}

Параметры

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

Строковый код типа

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

Адрес обработчика пользовательского типа

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

Текстовое название типа. Будет выводиться в административном интерфейсе настройки пользовательских полей

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

Текстовое описание типа. Будет выводиться в административном интерфейсе настройки пользовательских полей

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

Дополнительные настройки. На данный момент доступен один ключ: height — указывает высоту пользовательского поля в пикселях. Применится любое положительное значение.
По умолчанию — 0. Если указано 0, то будет использована стандартная высота для отображения этого виджета

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "USER_TYPE_ID": "test_type",
    "HANDLER": "https://www.myapplication.com/handler/",
    "TITLE": "Updated test type",
    "DESCRIPTION": "Test userfield type for documentation with updated description",
    "OPTIONS": {
        "height": 60
    }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldtype.add

Ответ

HTTP-статус: 200

{
    "result":true,
    "time":{
        "start":1724421710.397825,
        "finish":1724421711.040353,
        "duration":0.6425280570983887,
        "processing":5.888938903808594e-5,
        "date_start":"2024-08-23T16:01:50+02:00",
        "date_finish":"2024-08-23T16:01:51+02:00","operating":0
    }
}

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

result boolean

Результат регистрации нового типа пользовательских полей

time time

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

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

HTTP-статус: 400

{
    "error":"ERROR_CORE",
    "error_description":"Unable to set placement handler: Handler already binded"
}
Код Описание Значение
ERROR_CORE Unable to set placement handler: Handler already binded HANDLER уже занят другим типом пользовательских полей этого приложения или USER_TYPE_ID уже используется другим приложением
ERROR_ARGUMENT Argument 'USER_TYPE_ID' is null or empty Не задан USER_TYPE_ID
ERROR_ARGUMENT Argument 'HANDLER' is null or empty Не задан HANDLER

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

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