ServerTools.getList (Method)

Returns one or more structures, each containing information about a CommonSpot tool. The structure's members containing information on the tool's name, description, URL, and category. If the argument to this command is an empty string, CommonSpot returns information for all tools.

Returns:

Tools_GetList_Result (query)

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

Field Name	Type	Description
Category	PlainText_NonNull	The category under which the tool is classified.
Description	PlainText_NonNull	The tool's description.
Name	PlainText_NonNull_255	The tool's name.
URL	ServerRelativeURL	The tool's URL.

Arguments:

Name	Type	Required	Description
name	PlainText_255	Optional. Defaults to an empty string.	A name of a tool that CommonSpot can run. If this is an empty string, CommonSpot returns information on all tools.
category	PlainText	Optional. Defaults to 'All'.	The name of the category to filter by or 'All' to return all categories.

Context:

License Requirements	None
Permission Requirements	server:ServerMaintenance
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	Customization is not supported for this method.

Error Codes:

None

Notes:

None