Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml, the actual workflow definition and meta data.
READ permission on the workflow item is required to be able to read the definition.
[This is preliminary documentation and is subject to change.]
Gets a global workflow item definition
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 identifier of the workflow item to read.
Return Value
Type: StringXml, the actual workflow definition and meta data.
<root> <status>0</status> <statustext>Success</statustext> <definitions> <definition> <id>Integer value</id> <uid>GUID string value</uid> <name>String value</name> <description>String value</description> <definition>String value</definition> <created>Date value</created> <createdby>String value</createdby> <modified>Date value</modified> <modifiedby>String value</modifiedby> </definition> </definitions> </root>
Element | Value description |
---|---|
root/definitions/definition/id | An integer that identifier the workflow item |
root/definitions/definition/uid | A globally unique identifier (GUID) associated with 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/definition | The actual definition of the workflow item. This is an embedded xml document |
root/definitions/definition/created | A value that indicates the date and time when the the workflow item was created. This value is in the SortableDateTimePattern (based on ISO 8601) format using local time (e.g. 2007-11-01T16:34:18) |
root/definitions/definition/createdby | The name of the person that created the workflow item. If the person no longer exists in Content Studio the SID (in the SSDL format) is displayed. |
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) |
root/definitions/definition/modifiedby | The name of the person that last modified the workflow item. If the person no longer exists in Content Studio the SID (in the SSDL format) is displayed. |
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 |
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