VersionHistory.getVersionComments (Method)
Return one or more structures, each containing information on a version's comments. Structure members include the comment's text, the version action, user ID, and so on.
Returns:
VersionHistory_GetVersionComments_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| ChangeLocation | PlainText | The name of the page or template where the change was made. |
| CommentBy | Person_FirstNameMiddleNameLastName | The name of the person taking the action in the form 'Firstname Middlename Lastname'. |
| CommentText | PlainText | The comment's text. |
| CommentTimestamp | Timestamp | The date and time at which action occurred. |
| ControlIDList | ControlIDList | A comma-delimited list of control IDs for the elements on the page to which the action was applied. |
| ControlNameList | PlainText | A comma-delimited list of the names of the element to which the action was applied. |
| IsPageCreationRecord | Boolean | Boolean value indicating if the current record is the record corresponding to page creation. |
| UserID | UserID | The ID of the user who took the action. |
| VersionAction | VersionAction | String identifying that last action performed on a version; for example, 'Approved', 'Published', 'Rejected' and so on. |
| VersionTimestamp | Timestamp_EmptyString | The date and time when the version was published. An empty string indicates that the element is not published. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageID | RealPageID_NonBaseTemplate | Required | A page's ID. |
| elementID | ControlID_0 | Optional. Defaults to '0'. | An element's ID. |
| versionTimestamp | Timestamp_EmptyString | Optional. Defaults to an empty string. | The version time stamp (in the form 'yyyy-mm-dd HH:mm:ss') of the version for which CommonSpot will return information for. If this is set to an empty string, information for all versions is returned. |
| action | VersionActionFilter | Optional. Defaults to 'All'. | String identifying an action performed on a version; for example, 'Approved', 'Published', 'Rejected' and so on. If you do not pass an argument, CommonSpot returns information for all actions. |
| applyLimit | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that a page's version history limit is applied when CommonSpot returns results. |
| publishedOnly | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that CommonSpot only returns information for published versions. |
| afterPageCreateVersionsOnly | Boolean | Optional. Defaults to '0'. |
Context:
| License Requirements | None |
| Permission Requirements | page:History |
| 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:
None
Notes:
None