WorkflowDefinitionList 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 workflow definition items

Namespace: ContentStudio.Document.Workflow.Management
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string List(
	int connectionId,
	int sessionId,
	WorkflowListSorting sortOrder
)

Parameters

connectionId
Type: SystemInt32
A value that identifies the web site
sessionId
Type: SystemInt32
A value that identifies the user's session. This value typically is retrieved from a call to the OpenSession method
sortOrder
Type: ContentStudio.Document.Workflow.ManagementWorkflowListSorting
A value that indicates how the returned list should be sorted.

Return Value

Type: String
Xml, containing a list of workflow items
Copy
<root>
  <status>0</status>
  <statustext>Success</statustext>
  <definitions>
    <definition>
      <id>Integer value</id>
      <name>String value</name>
      <description>String value</description>
      <modified>Date value</modified>
    </definition>
    <!-- more item can follow-->
  </definitions>
</root>
ElementValue description
root/definitions/definition/idAn integer that identifier the workflow item
root/definitions/definition/nameThe name of the workflow item
root/definitions/definition/descriptionA description of the workflow item
root/definitions/definition/modifiedA value that indicates the date and time when the the workflow item was last modified. 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
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSInvalidParameterExceptionA parameter has an invalid value
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
READ permission on the workflow definitions root object is required in order to list workflow items
See Also

Reference

WorkflowDefinition Class
ContentStudio.Document.Workflow.Management Namespace