Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Integer, the number of items deleted from the log.
The permissions needed to clear the workflow log is dependent on what scope is specified in the scope parameter.
This procedure removes all entries that exists within the specified scope, thus if the Site scope is specified the entire log is cleared.
[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: Int32Integer, the number of items deleted from the log.
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 | DELETE CONTAINER permission on the site root object |
Category | DELETE CONTAINER permission on the category specified in the objectId parameter. |
Document | DELETE CONTAINER permission on the category that hosts the document specified in the objectId parameter. |
Remarks
See Also