Subsite.getChildSubsites (Method)
Returns zero or more structures, each containing information about a subsite's child subsites; for examples, user permissions, the number of child subsites, the subsite's name, and so on.
Returns:
Subsite_GetChildSubsites_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CanAdminOrMaintain | Boolean | Boolean flag which when true indicates that the current user has SubsiteMaintenance or SubsiteAdmin permission. |
| CanCreatePages | Boolean | Boolean flag which when true indicates that the current user has CreatePage permission. |
| noOfChildSubsites | NonNegativeInteger | The number of child subsites. |
| noOfImages | NonNegativeInteger | The number of images in a subsite. |
| noOfMultimediaFiles | NonNegativeInteger | The number of multimedia files in this subsite. |
| noOfPages | NonNegativeInteger | The number of pages in this subsite. |
| noOfRegisteredURLs | NonNegativeInteger | The number of registered URLs in this subsite. |
| noOfTemplates | NonNegativeInteger | The number of templates in this subsite. |
| noOfUploadedDocs | NonNegativeInteger | The number of uploaded documents in this subsite. |
| Status | Any | |
| SubsiteDescription | PlainText_2000 | The subsite's description. |
| SubsiteID | SubsiteID | The subsite's ID. |
| SubsiteName | PlainText_NonNull_255 | The subsite's name. |
| SubsiteURL | SubsiteURL | The subsite's URL. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| subsiteIDOrURL | SubsiteIDorURL_EmptyString | Required | The ID of the target subsite, or the server relative path to the target subsite, or an empty string for the current subsite. |
| includeCounts | Boolean | Optional. Defaults to '0'. | A Boolean flag which when set to true indicates that this method will return the number of items for each subsite. Setting this value to true may make evaluating this method resource-intensive, which will slow down server performance. |
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 | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 54011 | You must specify either a valid subsiteID or SubsiteURL. |
| 54012 | If you are passing both SubsiteID and SubsiteURL, they must refer to the same subsite. |
Notes:
None