Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
The xml elements returned has the following values and meaning
The attributes in the returned element root/logs contains the following attributes with values an meaning.
The permissions needed to read the workflow log is dependent on what level to read on.
[This is preliminary documentation and is subject to change.]
Gets a paged list of log items on a specific scope.
Namespace: ContentStudio.Document.Workflow.Management
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string List( ConnectionId connectionId, SessionId sessionId, int objectId, int currentId, WFLogManagerLogScope scope, WFLogManagerLoglistFilter filter, WFLogManagerLoglistSortOrder sortOrder, int pageSize, ref int pageNumber, 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 typically is retrieved from a call to the OpenSession method - objectId
- Type: SystemInt32
An identifier to an object to list log items for. What type of object this identifier represents is dependent of the value of the scope parameter. For Site use the value 1 - currentId
- Type: SystemInt32
Represents an existing object id. This parameter is used to ensure that the data page of a specific item is returned regardless of the pageNumber specified. This ensures that you will not lose track of a selected log item when the list is re-sorted and the item is placed on a different data page. If this parameter is zero the pageNumber parameter will be used to specify the data page to return rather than currentId. - scope
- Type: ContentStudio.Document.Workflow.ManagementWFLogManagerLogScope
A value that specifies for what type of object to list workflow log items from. - filter
- Type: ContentStudio.Document.Workflow.ManagementWFLogManagerLoglistFilter
Indicates what type of log items to return in the list. - sortOrder
- Type: ContentStudio.Document.Workflow.ManagementWFLogManagerLoglistSortOrder
Specifies how the returned list of log items should be sorted. - pageSize
- Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 PageSize will be 1. - pageNumber
- Type: SystemInt32
The page number to read. If this value is less than 1 PageNumber will be 1.
If currentId is specified the input value of this parameter will be ignored. After the call this parameter contains the number of the data page returned. This value can be used by code that specifies the currentId parameter and needs to know the page number of that item. - pageCount
- Type: SystemInt32
After the call this parameter contains the total number of data pages found. This parameter is passed uninitialized. - recordCount
- Type: SystemInt32
After the call this parameter contains the total number of log items found. This parameter is passed uninitialized.
Return Value
Type: StringXml
<root> <status>0</status> <statustext>Success</statustext> <pageno>Integer value</pageno> <pagecount>Integer value</pagecount> <recordcount>Integer value</recordcount> <filtercriteria>Integer value</filtercriteria> <logs> <log id="Integer value" level="Integer value" logdate="Date/time value" summary="String value" details="String value" title="String value" username="String value" documentid="Integer value" categoryid="Integer value" categoryname="String value" /> <!-- more log elements follow --> </logs> </root>
Element | Value and meaning |
---|---|
root/status | An Integer with the value zero indication success. This value is used by the AJAX based administrative interface to indicate that a successful call was made. |
root/statustext | The string Success. This value is used by the AJAX based administrative interface to indicate that a successful call was made. |
root/pageno | An Integer that specifies the data page number returned. This value is used by the AJAX based administrative interface and is the same as the pageNumber output parameter. |
root/pagecount | An Integer that specifies the total number of pages found. This value is used by the AJAX based administrative interface and is the same as the pageCount output parameter. |
root/recordcount | An Integer that specifies the total number of items found. This value is used by the AJAX based administrative interface and is the same as the recordCount output parameter. |
root/filtercriteria | An Integer that specifies the filter that was passed in. This value is used by the AJAX based administrative interface and is the same as the filter output parameter. |
root/logs/log | One or more elements that hosts the attributes that contains the actual data returned. |
Attribute | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id | Integer, the identifier of the item returned. | ||||||||||
level | Integer, the type of log item.
This attribute can have on of the following values:
| ||||||||||
logdate | A date time value that indicates when the log item was written to the log. This value is in the SortableDateTimePattern (based on ISO 8601) format using local time (e.g. 2007-11-01T16:34:18) | ||||||||||
summary | String, a brief description of the event | ||||||||||
details | String, a detailed message of the returned item. | ||||||||||
title | String, the title of the log item. | ||||||||||
username | String, the name of the user that is involved in the logged workflow action. | ||||||||||
documentid | Integer, an identifier to the document the is subject to workflow. | ||||||||||
categoryid | Integer, the identifier of the category that hosts the affected document. | ||||||||||
categoryname | String, The name of the category that host the document that uses the workflow. | ||||||||||
wfinstance | Guid, that uniquely identifiers the instance definition used by the workflow that created the log. This value is equal to the internal revision identifier of the document versioning that was affected by the workflow. |
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
CSPermissionDeniedException | The caller has no permission to perform the requested action |
CSInvalidSessionException | The session is invalid |
CSInvalidParameterException | A parameter has a invalid value. |
CSDocumentNotFoundException | The object specified in the objectId parameter could not be found |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
Level | Permission required |
---|---|
Site | READ CONTAINER permission on the site root object |
Category | READ CONTAINER permission on the category specified in the objectId parameter. |
Document | READ CONTAINER permission on the category that hosts the document specified in the objectId parameter. |
See Also