При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Изменить настройки типа пользовательских полей userfieldtype.update», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Изменить настройки типа пользовательских полей userfieldtype.update

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

Метод userfieldtype.update изменяет настройки зарегистрированного приложением типа пользовательских полей. Возвращает _true_ или ошибку с описанием причины.

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

Примеры кода

• cURL (Webhook)

    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_webbhook_here**/userfieldtype.update

• cURL (OAuth)

    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
        },
        "auth": "**put_access_token_here**"
    }' \
    https://**put_your_bitrix24_address**/rest/userfieldtype.update

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'userfieldtype.update',
    		{
    			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,
    			},
    		}
    	);
    	
    	const result = response.getData().result;
    	console.log(result);
    }
    catch( error )
    {
    	console.error(error);
    }

• PHP

    try {
        $result = $serviceBuilder->getPlacementScope()
            ->userFieldType()
            ->update(
                'custom_user_type',  // userTypeId
                'https://example.com/handler',  // handlerUrl
                'Custom User Type',  // title
                'Description of custom user type'  // description
            );
        if ($result->isSuccess()) {
            print("Update successful.");
        } else {
            print("Update failed.");
        }
    } catch (Throwable $e) {
        print("An error occurred: " . $e->getMessage());
    }

• BX24.js

    BX24.callMethod(
        'userfieldtype.update',
        {
            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,
            },
        },
        function(result)
        {
            if(result.error())
                console.error(result.error());
            else
                console.log(result.data());
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'userfieldtype.update',
        [
            'USER_TYPE_ID' => 'test_type',
            'HANDLER' => 'https://www.myapplication.com/handler/',
            'TITLE' => 'Upd ated test type',
            'DESCRIPTION' => 'Test userfield type for documentation with updated description',
            'OPTIONS' => [
                'height' => 60
            ]
        ]
    );

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

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

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
    }
}

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

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

HTTP-статус: 400

{
    "error":"ERROR_NOT_FOUND",
    "error_description":"User Field Type not found"
}

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

• [](./userfieldtype-add)
• [](./userfieldtype-list)
• [](./userfieldtype-delete)