WFLogManagerClear Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Clears the workflow log at the specified scope

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

public int Clear(
	ConnectionId connectionId,
	SessionId sessionId,
	int objectId,
	WFLogManagerLogScope scope
)

Parameters

connectionId
Type: ContentStudioConnectionId
A value that identifies the web site
sessionId
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session.
objectId
Type: SystemInt32
An identifier to an object that identifies the scope where the log items to delete exists. What type of object this identifier represents is dependent of the value of the scope parameter. For Site use the value 1
scope
Type: ContentStudio.Document.Workflow.ManagementWFLogManagerLogScope
Specifies in what scope to delete items.

Return Value

Type: Int32
Integer, the number of items deleted from the log.
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSInvalidParameterExceptionA parameter has a invalid value.
CSDocumentNotFoundExceptionThe object specified in the objectId parameter could not be found
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

The permissions needed to clear the workflow log is dependent on what scope is specified in the scope parameter.
LevelPermission required
SiteDELETE CONTAINER permission on the site root object
CategoryDELETE CONTAINER permission on the category specified in the objectId parameter.
DocumentDELETE CONTAINER permission on the category that hosts the document specified in the objectId parameter.
Remarks

This procedure removes all entries that exists within the specified scope, thus if the Site scope is specified the entire log is cleared.
See Also

Reference