Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml, containing a list of workflow items
READ permission on the workflow definitions root object is required in order to list workflow items
[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
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: StringXml, containing a list of workflow items
<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>
Element | Value description |
---|---|
root/definitions/definition/id | An integer that identifier the workflow item |
root/definitions/definition/name | The name of the workflow item |
root/definitions/definition/description | A description of the workflow item |
root/definitions/definition/modified | A 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
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 |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also