Search.getCollectionUsage (Method)

Returns a collection of object records (subsites and custom elements) which use the specified collection. If the collection name is empty, returns object records for subsites/custom elements which do not have an assigned full-text collection.

Returns:

CollectionUsage_Result (query)

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

Field Name Type Description
Description String Object description (URL for subsite, may be blank for custom elements).
Name String Object name (subsite or GCE name).
ObjectID PositiveInteger Object ID (subsite or custom element).
ObjectType NonNullString_50 Subsite or GCE.
userCanAdmin Boolean  

Arguments:

Name Type Required Description
collectionName CollectionName_Existing_EmptyString Required  

Context:

License Requirements FullTextIndex
Permission Requirements Contributor
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