StatisticsGetActionHistory Method (ConnectionId, SessionId, Int32, CSFileObjectTypes, StatisticsDocumentActions, Int32, Int32, Int32, Int32) 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)
Syntax

public string GetActionHistory(
	ConnectionId connectionId,
	SessionId sessionId,
	int objectId,
	CSFileObjectTypes objectType,
	StatisticsDocumentActions[] actionList,
	int pageNumber,
	int pageSize,
	out int pageCount,
	out int recordCount
)

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).
objectId
Type: SystemInt32
The id of the object to list statistics for. This can be a DocumentID or a ContainerID depending on the type of object indicated by the objectType parameter
objectType
Type: ContentStudio.DocumentCSFileObjectTypes
The type of object indicated by the objectId parameter.
actionList
Type: ContentStudio.DocumentStatisticsDocumentActions
An array of StatisticsDocumentActions actions to include in returned list
pageNumber
Type: SystemInt32
The page number to read. If this value is less than 1 PageNumber will be 1.
pageSize
Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10.
pageCount
Type: SystemInt32
The total pages of data found
recordCount
Type: SystemInt32
The total entries found

Return Value

Type: String
Xml, with the following syntax
<root>
  <status>0</status>
  <statustext>Success</statustext>
  <pageno>Integer value</pageno>
  <pagesize>Integer value</pagesize>
  <pagecount>Integer value</pagecount>
  <recordcount>Integer value</recordcount>
  <document>
    <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 -->
  </document>
</root>

Each action element contains the following attributes and meaning

AttributeDescription
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.
ValueMeaning
1Created.
2Updated.
3Approved.
4Restored an old version.
5Checked in.
6Checked out.
7Deleted (sent to recycling bin).
8Acquired
9Restored from recycling bin.
10Sent for versioning / workflow
11Terminated workflow / versioning
12Rejected
13Moved within a hierarchy
14Added to a hierarchy
15Detached from a hierarchy
16Relocated to another category (added in CS 5.5)
17Published
18Unpublished
19Archived
20Renamed
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.
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
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.
See Also

Reference