Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml with the following sample syntax:
READ permission on the document is required.
This is the backwards compatible implementation of this method.
This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the status and statusText output parameters.
[This is preliminary documentation and is subject to change.]
Retrieves a list of the version history of an element.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetVersionHistory( ConnectionId connectionId, SessionId sessionId, string xmlParameterData, out int status, out string statusText )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - xmlParameterData
- Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema - status
- Type: SystemInt32
An integer indicating result of the call. Zero is success. - statusText
- Type: SystemString
The textual representation of the call result.
Return Value
Type: StringXml with the following sample syntax:
<root> <status>0</status> <statustext>Success</statustext> <revisions> <revision> <ishistory>Value</ishistory> <revision>Value</revision> <createdby>Value</createdby> <createddate>Value</createddate> <revisedby>Value</revisedby> <revisiondate>Value</revisiondate> <modifiedby>Value</modifiedby> <modifieddate>Value</modifieddate> </revision> <!--more revision element can follow--> </revisions> </root>
The returned document has a collection of revision elements that has the following child elements that contains the actual data. Note that in some cases some of the data elements can be omitted in the result.
Element | Data type | Description |
---|---|---|
root/revisions/revision/ishistory | Boolean (0 or 1) | Indicates whether the version is in the version history. Only the version published be false. |
root/revisions/revision/revision | Integer | The version number. |
root/revisions/revision/createdby | String | The name of the person that created the version. This field is omitted if the user account has been deleted in Content Studio. |
root/revisions/revision/createddate | DateTime | The date and time when the version was created. This is in the standard SortableDateTime pattern (based on ISO 8601 [yyyy-MM-ddTHH:mm:ss]) using the local time of the server when the version was created. |
root/revisions/revision/revisedby | String | The name of the person that approved the version for publishing. This field is omitted if the user account has been deleted in Content Studio. |
root/revisions/revision/revisiondate | DateTime | The date and time when the version was approved for publishing. This is in the standard SortableDateTime pattern (based on ISO 8601 [yyyy-MM-ddTHH:mm:ss]) using the local time of the server when the version was approved. |
root/revisions/revision/modifiedby | String | The name of the last person that modified the version. This field is omitted if the user account has been deleted in Content Studio. |
root/revisions/revision/modifieddate | DateTime | The date and time when the version was modified. This is in the standard SortableDateTime pattern (based on ISO 8601 [yyyy-MM-ddTHH:mm:ss]) using the local time of the server when the version was modified. |
Content Studio permissions
Remarks
See Also