Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
READ permission on the Workflow definition root object is required to be able to successfully execute this method.
[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
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: StringXml
<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>
Element | Description |
---|---|
root/items/item/id | The id of the category to which the workflow is connected |
root/items/item/name | The name of the category to which the workflow is connected |
root/items/item/description | Currently present but not used |
root/items/item/connector | The 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/connectdate | The 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
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
See Also