Reports.getPagesWithBrokenLinks (Method)
Returns zero or more structures, each containing information on a pages or template having broken links. This member's arguments limit the amount of returned information.
Returns:
Reports_GetPagesWithBrokenLinks_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. |
| 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. Values that have special meaning are: 0--Returns information result for all owners. -1--Returns information results for all owners except the current user. -2--Returns information all owners except the current user. |
| versionStateList | HistoryCurrentWIP_List_EmptyString | Optional. Defaults to '2'. | A comma-delimited list of one or more integers representing version states; for example, a list member can have values such as 1(History), 2 (Current), 3 (WIP), or an empty string for all version states. |
| linkStatusFilter | LinkStatusList | Optional. Defaults to 'Deleted,Broken'. | String used to filter an link's status; for example, a status can be 'Valid', 'Broken', 'Deleted', 'Ignore', 'SyntaxValid', 'SyntaxInvalid' and 'Unchecked'. |
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 |
|---|---|
| 37005 | Either 'includePages' or 'includeTemplates' must be specified. |
Notes:
None