WorkflowCategoryDefinition.Disconnect Method

WorkflowCategoryDefinitionDisconnect Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Removes a workflow definition on a category

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

Syntax

Copy

public void Disconnect(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId,
	int workflowId
)

Public Sub Disconnect ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	categoryId As CategoryId,
	workflowId As Integer
)

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
categoryId: Type: ContentStudio.DocumentCategoryId
The identifier of the category to connect to.
workflowId: Type: SystemInt32
The identifier of the Workflow definition to connect to the category. This workflow must exist and be connected to the category.

Exceptions

Exception	Condition
CSPermissionDeniedException	The caller has no permission to perform the requested action
CSInvalidSessionException	The session is invalid
CSDocumentNotFoundException	The workflow definition could not be found
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

WRITE CONTAINER permission on the category is required in order to succeed with the operation.

Remarks

When you disconnect a workflow definition from a category you effectively turns off workflow rules that are applied on a category. This is true only for documents that are not involved in any workflow, thus documents already on workflow are not affected until the workflow is finished.

Reference

WorkflowCategoryDefinition Class

ContentStudio.Document.Workflow.Management Namespace