Documentation

landing.site.getFolders

landing.site.getFolders(
    siteId,
    filter
)

Method gets multiple site folders.

Parameters

Parameter Description Available from version
siteId Site ID.

Attention: Requires access permissions to write into a specified site.

filter Optional filter. Can receive the following fields:
  • ACTIVE – folder active status (Y/N). Created as inactive by default;
  • DELETED – folder deleted (Y/N). Returns existing folders by default;
  • PARENT_ID – parent folder ID;
  • TITLE – folder title;
  • INDEX_ID – folder index page ID;
  • CODE – folder symbolic code;
  • CREATED_BY_ID – User ID who created the folder;
  • MODIFIED_BY_ID – User ID who updated the folder;

Example

BX24.callMethod(
    'landing.site.getFolders',
    {
        siteId: 1817,
        filter: {
            TITLE: 'Updated folder'
        }
    },
    function(result)
    {
        if(result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);


© «Bitrix24», 2001-2022
Up