Отправить пакет запросов BX24.callBatch

В некоторых случаях возникает необходимость отправить несколько запросов подряд. Например, при создании необходимых сущностей в процессе инсталляции приложения. Для оптимизации процесса можно использовать пакетное выполнение запросов.

void BX24.callBatch(
            Object|Array calls,
            [Function callback[,
            Boolean bHaltOnError = false]]
        );

Функция BX24.callBatch отправляет пакет запросов к REST-сервису. В случае вызова до BX24.init выполнение запроса будет отложено.

Параметры

Обязательные параметры отмечены *

Название
тип

Описание

calls*
object|array

Обычный или ассоциативный массив (объект) с запросами. Каждый запрос представляет собой либо массив [имя_метода, параметры_метода], либо объект {method: имя_метода, params: параметры_метода}.

В параметрах методов можно использовать макросы, позволяющие получить доступ к результатам предыдущих запросов текущего пакета. Макрос можно составить примерно так: $result[идентификатор_запроса][поле_ответа], где идентификатором запроса служит его ключ в массиве пакета запросов

callback
function

Функция-обработчик результата пакетного запроса. На вход получит массив или ассоциативный массив (объект) объектов ajaxResult с ключами, соответствующими ключам из пакета запросов

bHaltOnError
boolean

Флаг «прерывать исполнение пакета в при возникновении ошибки». По умолчанию — false (не прерывать)

Пример

BX24.init(() => {
            const prepareMessage = (name, lastName, departmentNumber) => {
                return `The current user ${name} ${lastName} is assigned to the departmen${departmentNumber > 1 ? 'ts ' : 't '}`;
            };
            BX24.callBatch({
                get_user: ['user.current', {}],
                get_department: {
                    method: 'department.get',
                    params: {
                        ID: '$result[get_user][UF_DEPARTMENT]',
                    },
                },
            }, (result) => {
                if (result.get_user.error() || result.get_department.error())
                {
                    if (result.get_user.error())
                    {
                        console.error(result.get_user.error());
                    }
        
                    if (result.get_department.error())
                    {
                        console.error(result.get_department.error());
                    }
                }
                else
                {
                    const departmentNumber = result.get_department.data().length;
                    let message = prepareMessage(result.get_user.data().NAME, result.get_user.data().LAST_NAME, departmentNumber);
        
                    for (let i = 0; i < departmentNumber; i++)
                    {
                        message += i === 0 ? '' : ', ';
                        message += result.get_department.data()[i].NAME;
                    }
        
                    alert(message);
                }
            }, true);
        });

Как использовать примеры в документации

Продолжите изучение

Предыдущая
Вызвать метод
Следующая
Вызвать интерфейс регистрации обработчика события