1. Home / Web Services API Version 8.x / GetFlowDef

GetFlowDef

Returns definition of the specified workflow.

Syntax

Visual Basic (declaration) 
Public Function GetFlowDef( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal DomainName as String, _ 
	ByVal WorkflowName as String) as XmlNode

C# (declaration) 
public XmlNode GetFlowDef( 
	string AuthenticationTicket,
	string DomainName,
	string WorkflowName)

Parameters

AuthenticationTicket
    string infoRouter ticket
DomainName
    string The domain/library name
WorkflowName
    string The name of the workflow

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the function returns the <rules> subnode.
if success = "false", the error attribute returns the error description.

<response success="true" error="">
  <FlowDef FlowDefID="56406" FlowName="Document workflow sample" DomainId="1469" DomainName="Documentation" ActiveFolderPath="\Documentation" RequiresStartUpPlayers="false">
    <StepDef StepNumber="1" StepName="1.step">
      <TaskDefs>
        <TaskDef TaskDefId="47987" TaskName="1.task" DeadLine="48" RequiredAssigneeCount="0" SuperVisorId="0" SuperVisorName="" SupervisorNotificationOnDue="0" Priority="5" AllowedStartTimeSpan="0" ReminderTimeSpan="0">
          <Requirements>
            <Requirement Name="Edit" Value="False"/>
            <Requirement Name="LatestVersionRead" Value="True"/>
            <Requirement Name="PublishedVersionRead" Value="False"/>
            <Requirement Name="Comments" Value="False"/>
            <Requirement Name="Approval" Value="True"/>
            <Requirement Name="ISOReview" Value="False"/>
            <Requirement Name="SOXReview" Value="False"/>
            <Requirement Name="Dispose" Value="False"/>
            <Requirement Name="Archive" Value="False"/>
            <Requirement Name="Downgrade" Value="False"/>
            <Requirement Name="Declassify" Value="False"/>
          </Requirements>
          <Permissions>
            <Permission Name="EditDocument" Value="False"/>
            <Permission Name="ChangeFinishdate" Value="False"/>
            <Permission Name="Postpone" Value="False"/>
            <Permission Name="ChangePriority" Value="False"/>
            <Permission Name="EditNextStep" Value="True"/>
            <Permission Name="EditAllSteps" Value="True"/>
          </Permissions>
          <instruction>Please approve or reject the document</instruction>
          <AssigneeList>
            <Users>
              <User exists="true" UserID="1045" Domain="" UserName="JoeD" FirstName="Joe" LastName="Doe" Email="joe@acme.com" LastLogonDate="2013-05-24 18:03:52" LastPasswordChangeDate="1980-01-01 00:00:00" AuthenticationAuthority="INFOROUTER" ReadOnlyUser="FALSE" Enabled="TRUE"/>
            </Users>
            <UserGroups/>
            <SpecialUserRoles/>
          </AssigneeList>
        </TaskDef>
        <TaskDef TaskDefId="48021" TaskName="2.Task" DeadLine="24" RequiredAssigneeCount="0" SuperVisorId="0" SuperVisorName="" SupervisorNotificationOnDue="0" Priority="5" AllowedStartTimeSpan="0" ReminderTimeSpan="0">
          <Requirements>
            <Requirement Name="Edit" Value="False"/>
            <Requirement Name="LatestVersionRead" Value="False"/>
            <Requirement Name="PublishedVersionRead" Value="False"/>
            <Requirement Name="Comments" Value="False"/>
            <Requirement Name="Approval" Value="False"/>
            <Requirement Name="ISOReview" Value="False"/>
            <Requirement Name="SOXReview" Value="False"/>
            <Requirement Name="Dispose" Value="False"/>
            <Requirement Name="Archive" Value="False"/>
            <Requirement Name="Downgrade" Value="False"/>
            <Requirement Name="Declassify" Value="False"/>
          </Requirements>
          <Permissions>
            <Permission Name="EditDocument" Value="True"/>
            <Permission Name="ChangeFinishdate" Value="False"/>
            <Permission Name="Postpone" Value="True"/>
            <Permission Name="ChangePriority" Value="False"/>
            <Permission Name="EditNextStep" Value="False"/>
            <Permission Name="EditAllSteps" Value="False"/>
          </Permissions>
          <instruction>Please edit the document as commented</instruction>
          <AssigneeList>
            <Users>
              <User exists="true" UserID="1013" Domain="" UserName="Jack" FirstName="Jack" LastName="Floyd" Email="jack@acme.com" LastLogonDate="2013-05-24 17:13:56" LastPasswordChangeDate="1980-01-01 00:00:00" AuthenticationAuthority="INFOROUTER" ReadOnlyUser="FALSE" Enabled="TRUE"/>
              <User exists="true" UserID="1037" Domain="" UserName="Jill" FirstName="Jill" LastName="mcmillan" Email="mcmillan@acme.com" LastLogonDate="2013-05-24 18:04:46" LastPasswordChangeDate="1980-01-01 00:00:00" AuthenticationAuthority="INFOROUTER" ReadOnlyUser="FALSE" Enabled="TRUE"/>
              <User exists="true" UserID="1045" Domain="" UserName="Karen" FirstName="Karen" LastName="M" Email="KarenM@acme.com" LastLogonDate="2013-05-24 18:03:52" LastPasswordChangeDate="1980-01-01 00:00:00" AuthenticationAuthority="INFOROUTER" ReadOnlyUser="FALSE" Enabled="TRUE"/>
            </Users>
            <UserGroups/>
            <SpecialUserRoles/>
          </AssigneeList>
        </TaskDef>
      </TaskDefs>
    </StepDef>
    <StepDef StepNumber="2" StepName="2.step">
      <TaskDefs>
        <TaskDef TaskDefId="48022" TaskName="Review Task" DeadLine="24" RequiredAssigneeCount="0" SuperVisorId="0" SuperVisorName="" SupervisorNotificationOnDue="0" Priority="5" AllowedStartTimeSpan="0" ReminderTimeSpan="0">
          <Requirements>
            <Requirement Name="Edit" Value="False"/>
            <Requirement Name="LatestVersionRead" Value="True"/>
            <Requirement Name="PublishedVersionRead" Value="False"/>
            <Requirement Name="Comments" Value="False"/>
            <Requirement Name="Approval" Value="False"/>
            <Requirement Name="ISOReview" Value="False"/>
            <Requirement Name="SOXReview" Value="False"/>
            <Requirement Name="Dispose" Value="False"/>
            <Requirement Name="Archive" Value="False"/>
            <Requirement Name="Downgrade" Value="False"/>
            <Requirement Name="Declassify" Value="False"/>
          </Requirements>
          <Permissions>
            <Permission Name="EditDocument" Value="True"/>
            <Permission Name="ChangeFinishdate" Value="False"/>
            <Permission Name="Postpone" Value="False"/>
            <Permission Name="ChangePriority" Value="False"/>
            <Permission Name="EditNextStep" Value="False"/>
            <Permission Name="EditAllSteps" Value="False"/>
          </Permissions>
          <instruction>Please review the document and edit if nesessary</instruction>
          <AssigneeList>
            <Users>
              <User exists="true" UserID="1053" Domain="" UserName="Lilly" FirstName="Lilly" LastName="Jackson" Email="lilly@acme.com" LastLogonDate="2013-05-24 18:02:25" LastPasswordChangeDate="1980-01-01 00:00:00" AuthenticationAuthority="INFOROUTER" ReadOnlyUser="FALSE" Enabled="TRUE"/>
            </Users>
            <UserGroups/>
            <SpecialUserRoles/>
          </AssigneeList>
        </TaskDef>
      </TaskDefs>
    </StepDef>
  </FlowDef>
</response>

Remarks

-

See Also