Search.getCollectionSubsites (Method)

Returns one or more structures, each containing information on a collection's subsites, as follows: the subsite's ID and its URL.

Returns:

Search_GetCollectionSubsites_Result (query)

Each row of the returned query results has the following fields:

Field Name Type Description
SubsiteID SubsiteID The subsite's ID.
SubsiteURL SubsiteURL The subsite's URL.

Arguments:

Name Type Required Description
collectionName CollectionName_Existing_EmptyString_All Required A collection's name (to return subsites assigned to that collection), empty string (to return subsites with no assigned collection) or 'All' (for all subsites).

Context:

License Requirements Search
Permission Requirements ContributorOrServerCode
Deny Context None
Require Context (none)
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization This method may be customized at the site level

Error Codes:

None

Notes:

None