Element.getUsageSummary (Method)

 

Returns:

Element_GetUsageSummary_Result (query)

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

Field Name	Type	Description
ControlTypeID	ElementTypeID	ControlTypeID for this record.
LongDescription	PlainText	Long Description - more detailed description for this element type.
ShortDescription	NonNullString	Short Description - contains human-readable 'common' name for the element type.
UsageCount	NonNegativeInteger	Count of instances found.

Arguments:

Name	Type	Required	Description
controlTypeID	ElementTypeID_0	Required	An element's ID. If this value is 0, CommonSpot returns information for all elements instead of just one.
category	ElementCategoryFilter	Optional. Defaults to 'ALL'.
state	ElementStateFilter	Optional. Defaults to 'Active'.
type	ElementTypeFilter	Optional. Defaults to 'All'.
searchString	PlainText_100	Optional. Defaults to an empty string.
searchOperator	SearchOperator_EmptyString	Optional. Defaults to an empty string.
subsiteFilter	SubsiteFilter	Optional. Defaults to '0'.	The subsite's ID. If this value is -1, CommonSpot returns information on the current subsite. If this is 0, CommonSpot returns information for all subsites.
includeChildSubsites	Boolean	Optional. Defaults to '1'.	Boolean flag which when set to true tells CommonSpot to include all of a subsite's children when searching for usage information.
wipStatus	ElementUsageWipStatusFilter	Optional. Defaults to 'Current'.

Context:

License Requirements	None
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:

Returns a query containing usage information for the specified element type, filtered by the given criteria.