How to Execute a Batch Request

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
                "halt": 0,
                "cmd": {
                    "get_user": "user.current",
                    "get_departments": "department.get",
                    "get_app": "app.info"
                },
                "auth":"**put_access_token_here**"
            }' \
        https://**put_your_bitrix24_address**/rest/batch
        

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          // Named commands: each key becomes the identifier of its subrequest
          const response = await $b24.actions.v2.batch.make({
            calls: {
              get_user: { method: 'user.current', params: {} },
              get_departments: { method: 'department.get', params: {} },
              get_app: { method: 'app.info', params: {} }
            },
            options: {
              isHaltOnError: false, // analog of halt = 0: run every subrequest
              returnAjaxResult: true, // wrap each subrequest result in an AjaxResult
              requestId: Text.getUuidRfc4122()
            }
          })
        
          // isSuccess reflects the batch call as a whole
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            // getData() returns an object keyed by the command names above
            const result = response.getData()
            console.info(result.get_user.getData()?.result)
            console.info(result.get_departments.getData()?.result)
            console.info(result.get_app.getData()?.result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function runBatch() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // Named commands: each key becomes the identifier of its subrequest
              const response = await $b24.actions.v2.batch.make({
                calls: {
                  get_user: { method: 'user.current', params: {} },
                  get_departments: { method: 'department.get', params: {} },
                  get_app: { method: 'app.info', params: {} }
                },
                options: {
                  isHaltOnError: false, // analog of halt = 0: run every subrequest
                  returnAjaxResult: true, // wrap each subrequest result in an AjaxResult
                  requestId: B24Js.Text.getUuidRfc4122()
                }
              })
        
              // isSuccess reflects the batch call as a whole
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              // getData() returns an object keyed by the command names above
              const result = response.getData()
              console.info(result.get_user.getData()?.result)
              console.info(result.get_departments.getData()?.result)
              console.info(result.get_app.getData()?.result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', runBatch)
        </script>
        

BX24.callBatch({
            get_user: ['user.current', {}],
            get_departments: ['department.get', {}],
            get_app: ['app.info', {}]
        }, function(result) {
        
            console.log('get_user result: ', result.get_user.data());
            console.log('get_departments result: ', result.get_departments.data());
            console.log('get_app result: ', result.get_app.data());
        });
        

$result = \CRest::callBatch(
            // Commands
            [
                'get_user' => [
                    'method' => 'user.current',
                    'params' => []
                ],
                'get_departments' => [
                    'method' => 'department.get',
                    'params' => []
                ],
                'get_app' => [
                    'method' => 'app.info',
                    'params' => []
                ],
            ],
            // Halt
            false
        );
        
        echo "<pre>";
        var_dump($result);
        echo "</pre>";
        

curl -X POST \
        -H "Content-Type: application/json" \
        -d '{
                "halt": 0,
                "cmd": {
                    "get_user": "user.current",
                    "get_department": "department.get?ID=$result[get_user][UF_DEPARTMENT][0]"
                },
                "auth":"**put_access_token_here**"
            }' \
        https://**put_your_bitrix24_address**/rest/batch
        

BX24.callBatch({
            get_user: ['user.current', {}],
            get_department: {
                method: 'department.get',
                params: {
                    ID: '$result[get_user][UF_DEPARTMENT][0]'
                }
            }
        }, function(result) {
        
            console.log('Raw result: ', result);
            console.log('get_user result: ', result.get_user.data());
            console.log('get_department result: ', result.get_department.data());
        });
        

$result = \CRest::callBatch(
            // Commands
            [
                'get_user' => [
                    'method' => 'user.current',
                    'params' => []
                ],
                'get_department' => [
                    'method' => 'department.get',
                    'params' => [
                        "ID" => '$result[get_user][UF_DEPARTMENT][0]'
                    ]
                ],
            ],
            // Halt
            false
        );
        
        echo "<pre>";
        var_dump($result);
        echo "</pre>";
        

{
            "result": {
                "result": [],
                "result_error": {
                    "get_user": {
                        "error": "insufficient_scope",
                        "error_description": ""
                    }
                },
                "result_total": [],
                "result_next": [],
                "result_time": []
            },
            "time": {
                "start": 1724916725.460891,
                "finish": 1724916725.851307,
                "duration": 0.39041590690612793,
                "processing": 0.0005991458892822266,
                "date_start": "2024-08-29T10:32:05+03:00",
                "date_finish": "2024-08-29T10:32:05+03:00"
            }
        }