Reports.getBaseTemplates (Method)
Returns zero or more structures, each containing information about the specified subsite's base templates.
Returns:
Reports_GetBaseTemplates_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Category | PlainText_NonNull_255 | The template's category. |
| CategoryID | TemplateCategoryID_0 | The template's category ID. |
| Description | PlainText_NonNull_2000 | The template's description. |
| DirectChildCount | NonNegativeInteger | The number of templates and pages that directly derive from this base template. |
| FileName | ModulePath | The base template's file name if type is CFML or module path if type is URL. |
| GifURL | Any | The template image's URL. |
| isPublic | Boolean | Boolean flag which when true tells CommonSpot that it should display the base template in the template gallery. |
| ShortcutIconImageID | ImageID_0 | The ID of the shortcut icon image. |
| ShortcutIconImageServerURL | ServerRelativeURL_EmptyString | The url to the shortcuut icon image or an empty string. |
| ShortcutIconImageURL | ServerRelativeURL_EmptyString | The url to the shortcuut icon image or an empty string. |
| SubsiteID | SubsiteID | The subsite's ID. |
| SubsiteURL | SubsiteURL | The server-relative URL of the template's subsite. |
| TemplateID | BaseTemplateID | The template's ID. |
| Title | NonNullString | The template's internal CommonSpot title. |
| Type | BaseTemplateType | String identifying a base template's type, as follows: 'CFML' or 'URL'. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| templateID | BaseTemplateID_0 | Optional. Defaults to '0'. | The ID of the base template for which information is desired. If this value is 0, CommonSpot returns information for all base templates that fulfill the criteria set in other arguments to this method. |
| subsiteFilter | SubsiteFilter | Optional. Defaults to '0'. | The ID of the subsite in which CommonSpot searches for base templates. If this argument's value is 0, CommonSpot searches all subsites. If this argument's value is -1, CommonSpot searches in the current subsite. |
| includeChildSubsites | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true tells CommonSpot to include child subsites in its base template report. |
| includeOwnedOnly | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true tells CommonSpot to return information about templates owned by the current user. If the ''templateID' argument is set to a value other than 0, CommonSpot ignores this argument. |
| includeTemplateImagePath | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true, tells CommonSpot to return the URLs of a template's .gif image. Setting this argument to true means that this method will execute slightly slower. |
Context:
| License Requirements | (none) |
| Permission Requirements | ContributorOrServerCode |
| 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