Reports.getPagesByLinkReference (Method)
Returns zero or more structures, each containing information on the pages, templates, uploaded documents, and registered URLs that meet the specified criteria and how many pages refer to them.
Returns:
Reports_GetPagesByLinkReference_Result (rowlimitedquery)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| includePages | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that CommonSpot included pages are returned in the results. |
| includeUploadedDocs | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that uploaded documents are included in the results. |
| includeRegisteredURLs | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that registered URLs are included in the results. |
| includeTemplates | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that templates are included in the results. |
| displayDate | DisplayDate | Optional. Defaults to 'DateContentLastModified'. | A string describing the date field to display; for example, 'DateModified' or 'PublicReleaseDate'. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'DateContentLastModified DESC'. | 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. Special values are: 0: Returns all records. -1: Returns the number of records specified in the UI scalability setting. |
| subsiteFilter | SubsiteFilter | Optional. Defaults to '0'. | The ID of the subsite in which CommonSpot searches for objects. 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 that the results should include pages from child subsites. |
| dateFilterType | DateFilterType_EmptyString | Optional. Defaults to an empty string. | A string describing the date filter; for example, 'DateAdded' or 'PublicReleaseDate'. CommonSpot uses this value when looking for objects. If this argument is an empty string, CommonSpot does not use a date filter type. |
| dateFilter | DateFilterValue_EmptyString | Optional. Defaults to an empty string. | Sets the value of the filter that CommonSpot uses when returning results; for example 'This year', 'Last month', 'Last 2 months', and so on. |
| ownerIDList | UserIDList_0_NEG1_NEG2 | Optional. Defaults to '0'. | A comma-delimited list of user IDs. Here are special values that you can use: 0--Returns information for all owners. -1--Returns information for the current user, -2--Returns information for all owners except the current user. |
Context:
| License Requirements | (none) |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | (none) |
| Require Context | Authoring |
| 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 |
|---|---|
| 37006 | One of the following options must be specified: 'IncludePages', 'IncludeUploadedDocs', 'IncludeTemplates', or 'IncludeExternalURLs'. |
Notes:
None