Reports.getSubsites (Method)
Returns zero or more structures, each containing information about a search collection's full name and the subsite in which it resides. This method's argument create a subset of the information returned.
Returns:
Reports_GetSubsites_Result (rowlimitedquery)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| searchField | SubsiteSearchField | Optional. Defaults to 'Name'. | The field that CommonSpot searches. |
| searchOperator | SearchOperator_EmptyString | Optional. Defaults to 'Contains'. | The type of search comparison to use; for example, 'Contains', 'Begins with', 'Equals', and so on. |
| searchString | PlainText | Optional. Defaults to an empty string. | The text sought by CommonSpot in the field contained within the 'searchField' argument or its default value. |
| orderBy | SQLOrderByClause_EmptyString | Optional. Defaults to an empty string. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
| limit | QueryRowLimit | Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'. | An integer specifying one more than the maximum number of rows CommonSpot can return. Values with special meaning are: 0: Returns all records. -1: Return the number of records specified in the UI scalability setting. |
| excludeList | SubsiteIDList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of one or more subsite IDs that CommonSpot will exclude from a search. An empty string tells CommonSpot that is should not exclude any subsites. |
| requiredPermission | SubsiteGeneralPermission_EmptyString | Optional. Defaults to an empty string. | The name of the permission being checked. CommonSpot only searches subsites where the current user has this permission. |
| languageIDFilter | LanguageID_All | Optional. Defaults to 'All'. | A language's ID or 'All', which tells CommonSpot that it should not search using a language ID. |
| collectionNameFilter | CollectionName_Existing_EmptyString_All_None | Optional. Defaults to 'All'. | A search collection name, 'All', which find subsites regardless of what full text search collections they're indexed in, or 'None', which finds only ones that are not members of any collection. |
| excludeCollectionName | CollectionName_Existing_EmptyString | Optional. Defaults to an empty string. | Optional name of a full text search collection whose members should be excluded from the results. |
| includeList | SubsiteIDList_EmptyString | Optional. Defaults to an empty string. | If not empty, restricts subsite results to IDs in the list. |
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:
| Code | Error Message |
|---|---|
| 66027 | If a SearchField is specified, you must specify a SearchOperator. |
| 66028 | If a SearchOperator is specified, you must specify a SearchField. |
Notes:
None