WorkflowDefinitionRead Method Content Studio 5.7 SDK
Content Studio Web Content Management System

[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

public string Read(
	ConnectionId connectionId,
	SessionId sessionId,
	int workflowId
)

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: String
Xml, 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>
ElementValue description
root/definitions/definition/idAn integer that identifier the workflow item
root/definitions/definition/uidA globally unique identifier (GUID) associated with the workflow item
root/definitions/definition/nameThe name of the workflow item
root/definitions/definition/descriptionA description of the workflow item
root/definitions/definition/definitionThe actual definition of the workflow item. This is an embedded xml document
root/definitions/definition/createdA 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/createdbyThe 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/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)
root/definitions/definition/modifiedbyThe 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

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
CSDocumentNotFoundExceptionThe workflow definition could not be found
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

READ permission on the workflow item is required to be able to read the definition.
See Also

Reference