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

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

Gets a list of categories where a certain workflow is used

Namespace: ContentStudio.Document.Workflow.Management
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string ListUsage(
	ConnectionId connectionId,
	SessionId sessionId,
	int workflowId
)

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
workflowId
Type: SystemInt32
The workflow to list categories for.

Return Value

Type: String
Xml
Copy
<root>
  <status>0</status>
  <statustext>Success</statustext>
  <items>
   <item>
     <id>Integer value</id>
     <name>String value</name>
     <description>String value</description>
     <connector>String value</connector>
     <connectdate>Date value</connectdate>
   </item>
   <!-- more item elements can follow -->
  </items>
</root>
ElementDescription
root/items/item/idThe id of the category to which the workflow is connected
root/items/item/nameThe name of the category to which the workflow is connected
root/items/item/descriptionCurrently present but not used
root/items/item/connectorThe name of the person that connected the workflow to the category. If the person no longer exists in Content Studio the SID (in the SSDL format) is displayed.
root/items/item/connectdateThe date and time when the workflow was connected to the category. This value is in the SortableDateTimePattern (based on ISO 8601) format using local time (e.g. 2007-11-01T16:34:18)
Exceptions
ExceptionCondition
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSDocumentNotFoundExceptionThe Workflow definition could not be found
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
READ permission on the Workflow definition root object is required to be able to successfully execute this method.
See Also

Reference

WorkflowDefinition Class
ContentStudio.Document.Workflow.Management Namespace