StatisticsGetActionHistory Method (ConnectionId, SessionId, String, Int32, Int32, Int32, Int32, Int32, String) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns a paged list of actions performed on a single document or on all documents within a specific container.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

public string GetActionHistory(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	int pageNumber,
	int pageSize,
	out int pageCount,
	out int recordCount,
	out int status,
	out string statusText


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema The ActionList parameter consists of a string with the numerical representation of DocumentActions, each action separated by a comma. If this list contains non numerical items an error will occur.
Type: SystemInt32
The page number to read. If this value is less than 1 PageNumber will be 1.
Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10.
Type: SystemInt32
The total pages of data found
Type: SystemInt32
The total entries found
Type: SystemInt32
An integer indicating result of the call. Zero is success.
Type: SystemString
The textual representation of the call result.

Return Value

Type: String
Xml, with the following syntax
  <pageno>Integer value</pageno>
  <pagesize>Integer value</pagesize>
  <pagecount>Integer value</pagecount>
  <recordcount>Integer value</recordcount>
    <action documentid="Integer value" 
            documentname="String value" 
            number="Integer value" 
            action="Integer value" 
            actiontext="String value" 
            actiondate="DateTime value" 
            userid="Integer value"
            user="String value" />
    <!-- more action element follows -->

Each action element contains the following attributes and meaning

documentidInteger: the id of the document recorded
documentnameString: the name of the document including its path
numberInteger: a global identifier of the action
actionInteger: the action taken, this value can have on of the following values and meaning.
4Restored an old version.
5Checked in.
6Checked out.
7Deleted (sent to recycling bin).
9Restored from recycling bin.
10Sent for versioning / workflow
11Terminated workflow / versioning
13Moved within a hierarchy
14Added to a hierarchy
15Detached from a hierarchy
16Relocated to another category (added in CS 5.5)
actiontextString: the textual representation of the action value
actiondateThe date when the action was taken. This value is in the SortableDateTimePattern (based on ISO 8601) format using local time (e.g. 2007-11-01T16:34:18)
useridThe internal id of the user that performed the action.
userThe name of the user that performed the action. If the user is missing the string "---" is returned.
Content Studio permissions

Read permission on the category or on the document is required if the ObjectType is Category or Document. For Units and the Root the caller must have the GlobalGroupAdmin user right defined in order to succeed.

This is implementation is intended to be used by the Web-API layer in Content Studio admin. Applications should use the overloaded version 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.
See Also