Documentation

catalog.document.list

catalog.document.list(order, filter, select, offset, limit)

Method for getting list of items.

Returns list of items on in response body on success.

Parameters

ParameterТип Description
orderarray Sorting.
filterarray Filter.
selectarray List of retrieved fields.
offsetinteger Selection page, operates the same as start.
limitinteger Page size from 1 to 500 (when set as 0 or number higher than maximum, uses the default value 50).

Example

BX24.callMethod(
    'catalog.document.list', 
    {
        'order': {
            'ID': 'ASC',
        },
        'filter': {
          '>ID': 0,
        },
        'offset': 0,
        'limit': 50,
    }, 
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.log(result.data());
    }
);
$result = CRest::call(
    'catalog.document.list',
    [
        'order' => [
            'ID' => 'ASC',
        ],
        'filter' => [
            '>ID' => 0,
        ],
        'offset' => 0,
        'limit' => 5,
    ]
);

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

© «Bitrix24», 2001-2023
Up