Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Создать новое пользовательское поле реквизита crm.requisite.userfield.add», проанализируем лучшие практики и покажем, как правильно использовать crm.requisite.userfield.add в реальных задачах.

Создать новое пользовательское поле реквизита crm.requisite.userfield.add

> Scope: crm
>
> Кто может выполнять метод: любой пользователь

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

Системное ограничение на название поля — 20 знаков. К названию пользовательского поля всегда добавляется префикс UF_CRM_, то есть реальная длина названия — 13 знаков.

Параметры метода

Параметр fields

Примеры кода

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"USER_TYPE_ID":"string","ENTITY_ID":"CRM_REQUISITE","SORT":100,"MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"E","SHOW_IN_LIST":"Y","EDIT_FORM_LABEL":"ПП - Строка","LIST_COLUMN_LABEL":"ПП - Строка","LIST_FILTER_LABEL":"ПП - Строка","FIELD_NAME":"NEWTECH_v1_STRING"}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/crm.requisite.userfield.add

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"USER_TYPE_ID":"string","ENTITY_ID":"CRM_REQUISITE","SORT":100,"MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"E","SHOW_IN_LIST":"Y","EDIT_FORM_LABEL":"ПП - Строка","LIST_COLUMN_LABEL":"ПП - Строка","LIST_FILTER_LABEL":"ПП - Строка","FIELD_NAME":"NEWTECH_v1_STRING"},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.add

• JS

    try
    {
    	const response = await $b24.callMethod(
    		"crm.requisite.userfield.add",
    		{
    			fields:
    			{
    				"USER_TYPE_ID": "string",
    				"ENTITY_ID": "CRM_REQUISITE",
    				"SORT": 100,
    				"MULTIPLE": "N",
    				"MANDATORY": "N",
    				"SHOW_FILTER": "E",
    				"SHOW_IN_LIST": "Y",
    				"EDIT_FORM_LABEL": "ПП - Строка",
    				"LIST_COLUMN_LABEL": "ПП - Строка",
    				"LIST_FILTER_LABEL": "ПП - Строка",
    				"FIELD_NAME": "NEWTECH_v1_STRING"
    			}
    		}
    	);
    
    	const result = response.getData().result;
    	console.dir(result);
    }
    catch(error)
    {
    	console.error(error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'crm.requisite.userfield.add',
                [
                    'fields' => [
                        'USER_TYPE_ID'      => 'string',
                        'ENTITY_ID'         => 'CRM_REQUISITE',
                        'SORT'              => 100,
                        'MULTIPLE'          => 'N',
                        'MANDATORY'         => 'N',
                        'SHOW_FILTER'       => 'E',
                        'SHOW_IN_LIST'      => 'Y',
                        'EDIT_FORM_LABEL'   => 'ПП - Строка',
                        'LIST_COLUMN_LABEL' => 'ПП - Строка',
                        'LIST_FILTER_LABEL' => 'ПП - Строка',
                        'FIELD_NAME'        => 'NEWTECH_v1_STRING',
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error adding user field: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        "crm.requisite.userfield.add",
        {
            fields:
            {
              "USER_TYPE_ID": "string",
              "ENTITY_ID": "CRM_REQUISITE",
              "SORT": 100,
              "MULTIPLE": "N",
              "MANDATORY": "N",
              "SHOW_FILTER": "E",
              "SHOW_IN_LIST": "Y",
              "EDIT_FORM_LABEL": "ПП - Строка",
              "LIST_COLUMN_LABEL": "ПП - Строка",
              "LIST_FILTER_LABEL": "ПП - Строка",
              "FIELD_NAME": "NEWTECH_v1_STRING"
          }
        },
        function(result)
        {
            if(result.error())
                console.error(result.error());
            else
                console.dir(result.data());
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'crm.requisite.userfield.add',
        [
            'fields' => [
                'USER_TYPE_ID' => 'string',
                'ENTITY_ID' => 'CRM_REQUISITE',
                'SORT' => 100,
                'MULTIPLE' => 'N',
                'MANDATORY' => 'N',
                'SHOW_FILTER' => 'E',
                'SHOW_IN_LIST' => 'Y',
                'EDIT_FORM_LABEL' => 'ПП - Строка',
                'LIST_COLUMN_LABEL' => 'ПП - Строка',
                'LIST_FILTER_LABEL' => 'ПП - Строка',
                'FIELD_NAME' => 'NEWTECH_v1_STRING'
            ]
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
    "result": 235,
    "time": {
        "start": 1717681176.885836,
        "finish": 1717681177.353738,
        "duration": 0.46790218353271484,
        "processing": 0.084564208984375,
        "date_start": "2024-06-06T15:39:36+02:00",
        "date_finish": "2024-06-06T15:39:37+02:00",
        "operating": 0
    }
}

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

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

HTTP-статус: 40x, 50x

{
    "error": "ERROR_CORE",
    "error_description": "Поле UF_CRM_NEWTECH_V1_STRING для объекта CRM_REQUISITE уже существует."
}

Возможные ошибки

• [](./crm-requisite-userfield-update)
• [](./crm-requisite-userfield-get)
• [](./crm-requisite-userfield-list)
• [](./crm-requisite-userfield-delete)