WorkflowCategoryDefinitionList 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 workflows in use with this category

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

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 get the list from.

Return Value

Type: String
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>
  </items>
</root>
ElementDescription
root/items/item/idThe id of the workflow that is connected to the category
root/items/item/nameThe name of the workflow that is connected to the category
root/items/item/descriptionThe description of the workflow
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
CSExceptionA business rule was violated in the underlying Content Studio database
NumberMeaning
1503The category does not exist
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
READ CONTAINER permission on the category is required in order to successfully execute this method.
Remarks
The current implementation of the Workflow server does not support multiple workflow on a single category. For this reason only one item is returned.
See Also

Reference

WorkflowCategoryDefinition Class
ContentStudio.Document.Workflow.Management Namespace