Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Обновить действие bizproc.activity.update». Вы узнаете экспертные методики работы с bizproc.activity.update и научитесь избегать типичных ошибок начинающих разработчиков.

Обновить действие bizproc.activity.update

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

Метод обновляет действие бизнес-процессов, добавленное приложением.

Работает только в контексте приложения.

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

Параметр FIELDS {#parametr-fields}

'NAME': {
    'ru': 'название действия',
    'en': 'action name',
    ...
},

'DESCRIPTION': {
    'ru': 'описание действия',
    'en': 'action description',
    ...
},

    FILTER: {
        EXCLUDE: [ 'box' ]
    }

    FILTER: {
        INCLUDE: [
            ['lists']
        ]
    }

    FILTER: {
        INCLUDE: [
            ['lists'],
            ['crm', 'CCrmDocumentDeal']
        ]
    }

Объект PROPERTY {#property}

[
    'value1': 'title1',
    'value2': 'title2',
    'value3': 'title3',
    'value4': 'title4'
]

Примеры объектов

// пример для типа select
'docType': {
    'Name': {
        'ru': 'Тип документа',
        'en': 'Document type'
    },
    'Required': 'Y',
    'Multiple': 'N',
    'Default': 'PDF',
    'Type': 'select',
    'Options': {
        'pdf': 'PDF',
        'docx': 'DOCX'
    }
}

// пример для типа bool
'saveDoc': {
    'Name': {
        'ru': 'Сохранить документ',
        'en': 'Save document'
    },
    'Description': {
        'ru': 'Присвоить порядковый номер',
        'en': 'Assign a sequential number'
    },
    'Type': 'bool',
    'Required': 'Y',
    'Multiple': 'N',
    'Default': 'Y'
}

// пример для типа string
'Parameters': {
    'Name': {
        'ru': 'Параметры шаблона',
        'en': 'Template\'s parameters'
    },
    'Description': {
        'ru': 'ParamID={=ParamValue}',
        'en': 'ParamID={=ParamValue}'
    },
    'Type': 'string',
    'Required': 'N',
    'Multiple': 'Y'
}

Примеры кода

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"CODE":"action_test_code","FIELDS":{"AUTH_USER_ID":1,"USE_SUBSCRIPTION":"N","FILTER":{"INCLUDE":[["lists"],["crm","CCrmDocumentDeal"]]}}, "auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/bizproc.activity.update

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'bizproc.activity.update',
    		{
    			'CODE': 'action_test_code',
    			'FIELDS': {
    				'AUTH_USER_ID': 1,
    				'USE_SUBSCRIPTION': 'N',
    				'FILTER': {
    					'INCLUDE': [
    						['lists'],
    						['crm', 'CCrmDocumentDeal']
    					]
    				}
    			},
    		}
    	);
    	
    	const result = response.getData().result;
    	alert("Успешно: " + result);
    }
    catch( error )
    {
    	alert("Error: " + error);
    }

• PHP

    try {
        $result = $serviceBuilder
            ->getBizProcScope()
            ->activity()
            ->update(
                'activity_code',
                'https://example.com/handler',
                1,
                ['en' => 'Activity Name', 'ru' => 'Название Активности'],
                ['en' => 'Activity Description', 'ru' => 'Описание Активности'],
                true,
                ['param1' => 'value1'],
                false,
                ['returnParam1' => 'value1'],
                null,
                null
            );

        if ($result->isSuccess()) {
            print($result->getCoreResponse()->getResponseData()->getResult()[0]);
        } else {
            print('Update failed.');
        }
    } catch (Throwable $e) {
        print('Error: ' . $e->getMessage());
    }

• BX24.js

    BX24.callMethod(
        'bizproc.activity.update',
        {
            'CODE': 'action_test_code',
            'FIELDS': {
                'AUTH_USER_ID': 1,
                'USE_SUBSCRIPTION': 'N',
                'FILTER': {
                    'INCLUDE': [
                        ['lists'],
                        ['crm', 'CCrmDocumentDeal']
                    ]
                }
            },
        },
        function(result)
        {
            if(result.error())
                alert("Error: " + result.error());
            else
                alert("Успешно: " + result.data());
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'bizproc.activity.update',
        [
            'CODE' => 'action_test_code',
            'FIELDS' => [
                'AUTH_USER_ID' => 1,
                'USE_SUBSCRIPTION' => 'N',
                'FILTER' => [
                    'INCLUDE' => [
                        ['lists'],
                        ['crm', 'CCrmDocumentDeal']
                    ]
                ]
            ]
        ]
    );

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

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

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1738149954.2918739,
        "finish": 1738149954.4590819,
        "duration": 0.16720795631408691,
        "processing": 0.017282962799072266,
        "date_start": "2025-01-29T14:25:54+03:00",
        "date_finish": "2025-01-29T14:25:54+03:00",
        "operating_reset_at": 1738150554,
        "operating": 0
    }
}

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

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

HTTP-статус: 400

{
    "error": "ERROR_ACTIVITY_VALIDATION_FAILURE",
    "error_description": "Wrong properties array!"
}

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

• [](./index)
• [](./bizproc-activity-add)
• [](./bizproc-activity-list)
• [](./bizproc-activity-delete)
• [](./bizproc-activity-log)