метод REST scope: crm

crm.requisite.userfield.get

Получить пользовательское поле по id

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

Описание

Метод возвращает пользовательское поле реквизита по идентификатору.

Параметры

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

Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":235}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.get

Ответ

HTTP-статус: 200

{
    "result": {
        "ID": "235",
        "ENTITY_ID": "CRM_REQUISITE",
        "FIELD_NAME": "UF_CRM_NEWTECH_V1_STRING",
        "USER_TYPE_ID": "string",
        "XML_ID": null,
        "SORT": "100",
        "MULTIPLE": "N",
        "MANDATORY": "N",
        "SHOW_FILTER": "N",
        "SHOW_IN_LIST": "Y",
        "EDIT_IN_LIST": "Y",
        "IS_SEARCHABLE": "N",
        "SETTINGS": {
            "SIZE": 20,
            "ROWS": 1,
            "REGEXP": "",
            "MIN_LENGTH": 0,
            "MAX_LENGTH": 0,
            "DEFAULT_VALUE": ""
        },
        "EDIT_FORM_LABEL": {
            "en": "ПП - Строка",
            "ru": "ПП - Строка"
        },
        "LIST_COLUMN_LABEL": {
            "en": "ПП - Строка",
            "ru": "ПП - Строка"
        },
        "LIST_FILTER_LABEL": {
            "en": "ПП - Строка",
            "ru": "ПП - Строка"
        },
        "ERROR_MESSAGE": {
            "en": "UF_CRM_NEWTECH_V1_STRING",
            "ru": "UF_CRM_NEWTECH_V1_STRING"
        },
        "HELP_MESSAGE": {
            "en": "UF_CRM_NEWTECH_V1_STRING",
            "ru": "UF_CRM_NEWTECH_V1_STRING"
        }
    },
    "time": {
        "start": 1717686921.82579,
        "finish": 1717686922.874864,
        "duration": 1.0490741729736328,
        "processing": 0.05396890640258789,
        "date_start": "2024-06-06T17:15:21+02:00",
        "date_finish": "2024-06-06T17:15:22+02:00",
        "operating": 0
    }
}

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

result object

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

time time

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

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

{
    "error": "ERROR_NOT_FOUND",
    "error_description": "The entity with ID '235' is not found."
}
Код Описание Значение
Пустая строка ID is not defined or invalid Идентификатор пользовательского поля не задан или имеет недопустимое значение
ERROR_NOT_FOUND The entity with ID '235' is not found Пользовательское поле с указанным идентификатором не найдено
Пустая строка" Access denied Недостаточно прав доступа для получения пользовательского поля

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

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