Working with Site Types and Scopes

We are still updating this page

Some data may be missing — we will complete it shortly.

Site Types

Sites can be of the following types.

  • Main:

    • PAGE (from Home Page) - regular sites.
    • STORE - stores.
    • SMN - sites used in the Sites24 section in the administrative area of the BUS.

  • Additional:

    • KNOWLEDGE – knowledge bases.
    • GROUP – knowledge bases of social network groups.

Currently, the extension of types is not supported.

Scopes

In addition to the separation function at the component level, there is also a division by rights, known as scopes.

If you are working with main types, no action is needed.
If working with additional types, you need to set the scope before starting. In the case of REST, this can be done by passing an additional parameter scope.

Example

The example provides a method for retrieving a list of pages, but the rule applies to any other method, including working with rights and entity modifications.

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        const params = {
            select: ['ID', 'TITLE'],
            filter: {
                TITLE: '%services%',
                SITE_ID: 205
            },
            order: {
                ID: 'DESC'
            }
        };
        
        try {
            const response = await $b24.callListMethod(
                'landing.landing.getList',
                { params, scope: 'knowledge' }
            );
            const items = response.getData() || [];
            for (const entity of items) {
                console.log('Entity:', entity);
            }
        } catch (error) {
            console.error('Request failed', error);
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
            const generator = $b24.fetchListMethod('landing.landing.getList', { params, scope: 'knowledge' }, 'ID');
            for await (const page of generator) {
                for (const entity of page) {
                    console.log('Entity:', entity);
                }
            }
        } catch (error) {
            console.error('Request failed', error);
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
            const response = await $b24.callMethod('landing.landing.getList', { params, scope: 'knowledge' }, 0);
            const result = response.getData().result || [];
            for (const entity of result) {
                console.log('Entity:', entity);
            }
        } catch (error) {
            console.error('Request failed', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.landing.getList',
                    [
                        'params' => [
                            'select' => [
                                'ID', 'TITLE'
                            ],
                            'filter' => [
                                'TITLE'   => '%services%',
                                'SITE_ID' => 205
                            ],
                            'order'  => [
                                'ID' => 'DESC'
                            ]
                        ],
                        'scope'  => 'knowledge'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting landing list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.landing.getList',
            {
                params: {
                    select: [
                        'ID', 'TITLE'
                    ],
                    filter: {
                        TITLE: '%services%',
                        SITE_ID: 205
                    },
                    order: {
                        ID: 'DESC'
                    }
                },
                scope: 'knowledge'
            },
            function(result)
            {
                if(result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

How to Use Examples in Documentation

Previous
Overview of Methods
Next
Overview of Methods