WorkflowDefinition.Delete Method

WorkflowDefinitionDelete Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Deletes a workflow item

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

Syntax

public void Delete(
	ConnectionId connectionId,
	SessionId sessionId,
	int workflowId
)

Public Sub Delete ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	workflowId As Integer
)

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
workflowId: Type: SystemInt32
The identifier of the workflow item to delete

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 an invalid value
CSDocumentNotFoundException	The workflow definition could not be found
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

DELETE permission on the workflow item is required