Reports.getReportData (Method)
Structure whose members contain information about a page; for example, a page's description, and file name. Other members indicate if the page needs the current user's approval, if it is a work in progress page for the current user, and so on.
Returns:
DetailedPage_Result (rowlimitedquery)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| keywordList | PlainText_2000 | Optional. Defaults to an empty string. | A comma-delimited list of keywords. |
| keywordType | KeywordTagTypeFilter | Optional. Defaults to 'All'. | String identifying keyword and tag types, as follows: 'All', 'Keywords', and 'Tags'. |
| keywordSearchOperator | SearchOperator | Optional. Defaults to 'Contains'. | Strings identifying a search operators; for example: 'Begins With', 'Ends With', or 'Equals'. |
| keywordCaseMatch | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that the keywords located must have the same case as an item in the 'keywordList' argument. |
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 |
|---|---|
| 37004 | At least one document type must be selected. |
| 1000200 | If you specify a DateFilterType, you must also specify a DateFilter. |
| 1000201 | If you specify a DateFilter, you must specify a DateFilterType. |
Notes:
None