Versions Compared

Old Version 4

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Universal Controller supports the following RESTful-based web services for Workflow Task and Dependency operations, which are listed alphabetically on this page.

  • Add a Dependency to a Workflow
  • Add a Task to a Workflow
  • List Dependencies in a Workflow
  • List Tasks in a Workflow
  • Modify a Dependency in a Workflow
  • Modify a Task in a Workflow
  • Remove a Dependency from a Workflow
  • Remove Task(s) from a Workflow

Formatting specifications for each web service, including details about parameter requirements, are provided.
 

...

Anchor
Add a Dependency to a Workflow Example Request
Add a Dependency to a Workflow Example Request
Add a Dependency to a Workflow: Example Request

>
<condition>Success</condition>
&lt;

points

&gt;
<points>
&lt;point
<point x="280" y="300" /
&gt;
>
&lt;
</points
&gt;
>
&lt;

sourceId

XML

JSON


<pre> &lt;workflowEdge&gt;
<workflowEdge>
&lt;

condition

Expand
titleXML
Panel
Html bobswift
Html bobswift
&gt;Success&lt;

/condition

Html bobswift
Html bobswift
Html bobswift
Html bobswift
&gt;2&lt;

/sourceId

Html bobswift&gt;
<sourceId>2</sourceId>
&lt;

straightEdge

Html bobswift
&gt;false&lt;

/straightEdge

Html bobswift&gt;
<straightEdge>false</straightEdge>
&lt;

targetId

Html bobswift
&gt;3&lt;

/targetId

Html bobswift&gt; &lt;/workflowEdge&gt; </pre>
<targetId>3</targetId>
</workflowEdge>



<pre>
{
  "
condition
": {
    "value": "Success"
  },
  "
points
": [ {
     "x": "280",
     "y": "300"
  } ],
  "
sourceId
": {
    "value": "2"
  },
  "
straightEdge
": false,
  "
targetId
": {
    "value": "3"
  }
}
</pre>
 Expand
titleJSON
 Panel
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift

 Anchor
Add a Dependency to a Workflow Request Properties
Add a Dependency to a Workflow Request Properties
Add a Dependency to a Workflow: Request Properties
<ul>
<li> Success
<li> Failure
<li> 
  • Success
  • Failure
  • Success/Failure

<li> 
  • Exit 
 
  •  Code; 
 
  •  Format: 
 
  •  Numeric. 
 
  •  Use 
 
  •  commas 
 
  •  to 
 
  •  list 
 
  •  a 
 
  •  series 
 
  •  of 
 
  •  exit 
 
  •  codes; 
 
  •  use 
 
  •  hyphens 
 
  •  to 
 
  •  specify 
 
  •  a 
 
  •  range. 
 
  •  Example: 
 
  •  1,5, 
 
  •  22-30

<li> 
  • Step 
 
  •  Condition; 
 
  •  Format: 
 
  •  step:procedure:program:condition 
 
  •  codes. 
 
  •  Example: 
 
  •  *:*:*:JCLERR

<li> Variable
</ul>
  • Variable

Default is Success.
 
For example: 
        
Property
UI Field Name
Description
Specifications
Required
 Anchor
condition - ADW
condition - ADW
condition
n/a
 Dependency condition between the source and target tasks of this dependency (connector). 
Valid values:
 Html bobswift
 Panel
   <condition>Success<
  <condition>Success</condition>
   <condition>Failure</condition>
   <condition>Success/Failure</condition>
   <condition>1,5,22-30</condition>
   <condition>*:*:*:JCLERR</condition>
   <condition>S1:PROC1:PGM1:U016</condition>
   <condition type="Exit Code">1,5,22-30</condition>
   <condition type="Step Condition">*:*:*:JCLERR</condition>
   <condition type="Step Condition">*:*:*:S0C4</condition>
   <condition type="Step Condition">S1:PROC1:PGM1:U016</condition>
   <variableCondition>
           <firstValue>${_varToLowerCase('variableName')}</firstValue>
           <operator>=</operator>
           <secondValue>${var2}</secondValue>
   </variableCondition>

 
Step Condition is valid for z/OS tasks only.
 
Success/Failure and Failure are not valid for Workflow, Timer, and Manual tasks.
 
 Note
titleNote
The type attribute (type=) is optional for Exit Code and Step Condition. Based on the format of the condition, in most cases it is easily determined if the condition is Exit Code and Step Condition. If the condition cannot be determined, the type attribute can be checked.

N
 Anchor
points - ADW
points - ADW
points
n/a
If straightEdge is false; x and y coordinates of the Edge angles.
For example:
 
<pre>
&lt;points&gt;
	&lt;point
<points>
	<point x="280" y="300" /
&gt;
&lt;/points&gt;

>
</
pre>
points>
 Panel
 Html bobswift

N
 Anchor
sourceId - ADW
sourceId - ADW
sourceId
n/a
Vertex ID of the source task.

Y
 Anchor
straightEdge - ADW
straightEdge - ADW
straightEdge
n/a
Specification for whether the edge is straight or bent.
Boolean; Valid values: true/false. Default is true.
N
 Anchor
targetId - ADW
targetId - ADW
targetId
n/a
Vertex ID of the target task.

Y
...
     
XML
JSON

 Expand
titleXML
<workflowVertex>
      <alias>S30</alias>
      <task>Sleep 30</task>
      <vertexX>360</vertexX>
      <vertexY>60</vertexY>
</workflowVertex>


 Expand
titleJSON
{
  "alias": "S30",
  "task": {
  "value": "Sleep 30"
  }, 
  "vertexX": "360",
  "vertexY": "60"
}


 Anchor
Add a Task to a Workflow Example Response
Add a Task to a Workflow Example Response
Add a Task to a Workflow: Example Response (Status 200)
     
XML
JSON

 Expand
titleXML
<workflowVertex>
      <alias>S30</alias>
      <task>Sleep 30</task>
      <vertexId>9</vertexId>
      <vertexX>360</vertexX>
      <vertexY>60</vertexY>
</workflowVertex>


 Expand
titleJSON
{
  "alias": "S30",
  "task": {
  "value": "Sleep 30"
  }, 
  "vertexId": "9,
  "vertexX": "360",
  "vertexY": "60"
}

 Anchor
Add a Task to a Workflow Request Response Properties
Add a Task to a Workflow Request Response Properties
Add a Task to a Workflow: Request/Response Properties
...
 Anchor
List Dependencies in a Workflow Example Response
List Dependencies in a Workflow Example Response
List Dependencies in a Workflow: Example Response
&gt;
              
    &lt;
sourceId
<sourceId taskName="Sleep 30" taskAlias="test"
&gt;2&lt;
/sourceId
&gt;
>2</sourceId>
                 
&lt;
straightEdge
     
XML
JSON

<pre>
&lt;workflowEdges&gt;
<workflowEdges>
        <workflowEdge>
   
&lt;workflowEdge&gt;
              <condition>Success</condition>
   
&lt;
condition
 Expand
titleXML
 Panel
 Html bobswift
 Html bobswift
&gt;Success&lt;
/condition
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
&gt;true&lt;
/straightEdge
 Html bobswift&gt;
<straightEdge>true</straightEdge>
                 
&lt;
targetId
 Html bobswift taskName
<targetId taskName="Sleep 60"
&gt;3&lt;
/targetId
 Html bobswift&gt;
>3</targetId>
        
&lt;/workflowEdge&gt;
</workflowEdge>
        
&lt;workflowEdge&gt;
<workflowEdge>
                 
&lt;
condition
 Html bobswift
&gt;Success&lt;
/condition
 Html bobswift&gt;
<condition>Success</condition>
                 
&lt;
sourceId
 Html bobswift
<sourceId taskName="Sleep 60"
&gt;3&lt;
/sourceId
 Html bobswift&gt;
>3</sourceId>
                 
&lt;
straightEdge
 Html bobswift
&gt;true&lt;
/straightEdge
 Html bobswift&gt;
<straightEdge>true</straightEdge>
                 
&lt;
targetId
 Html bobswift
<targetId taskName="Sleep 60"
&gt;6&lt;
/targetId
 Html bobswift&gt;
>6</targetId>
        
&lt;/workflowEdge&gt;
&lt;/workflowEdges&gt; 
</pre>
</workflowEdge>
</workflowEdges> 


<pre>[

[
  {
  "
condition
": {
    "value": "Success"
  },
  "
sourceId
": {
    "taskAlias": "test",
    "taskName": "Sleep 30",
    "value": "2"
  },
  "
straightEdge
": true,
  "
targetId
": {
    "taskName": "Sleep 60",
    "value": "3"
  }
},
  {
  "
condition
": {
    "value": "Success"
  },
  "
sourceId
": {
    "taskName": "Sleep 60",
    "value": "3"
  },
  "
straightEdge
": true,
  "
targetId
": {
    "taskName": "Sleep 60",
    "value": "6"
  }
} 
]

</pre>
 Expand
titleJSON
 Panel
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift

 Anchor
List Dependencies in a Workflow Properties
List Dependencies in a Workflow Properties
List Dependencies in a Workflow: Properties
...
 Anchor
List Task in a Workflow Example Response
List Task in a Workflow Example Response
List Tasks in a Workflow: Example Response
<alias>Task 1</alias>
		<task sysId="1010f538c0a801c900e0fe0af94d9be5"
&gt;task1&lt;
/task
&gt;
>task1</task>
		
&lt;
vertexId
     
XML
JSON

<pre>
&lt;workflowVertices&gt;
	&lt;workflowVertex&gt;
<workflowVertices>
	<workflowVertex>
		
&lt;
alias
 Expand
titleXML
 Panel
 Html bobswift
 Html bobswift
&gt;Task 1&lt;
/alias
 Html bobswift
&gt;
		&lt;
task
 Html bobswift
 Html bobswift
 Html bobswift
&gt;5&lt;
/vertexId
 Html bobswift
&gt;
		&lt;
vertexX
 Html bobswift
&gt;253&lt;
/vertexX
 Html bobswift
&gt;
		&lt;
vertexY
 Html bobswift
&gt;296&lt;
/vertexY
 Html bobswift
&gt;
	&lt;/workflowVertex&gt;
	&lt;workflowVertex&gt;
		&lt;
alias
 Html bobswift
&gt;Task 2&lt;
/alias
 Html bobswift
&gt;
		&lt;
task
 Html bobswift
<vertexId>5</vertexId>
		<vertexX>253</vertexX>
		<vertexY>296</vertexY>
	</workflowVertex>
	<workflowVertex>
		<alias>Task 2</alias>
		<task sysId="f81d30ccc0a801c9008ea20e4f5f61d6"
&gt;task2&lt;
/task
 Html bobswift&gt;
>task2</task>
		
&lt;
vertexId
 Html bobswift
&gt;6&lt;
/vertexId
 Html bobswift
&gt;
		&lt;
vertexX
 Html bobswift
&gt;252.5&lt;
/vertexX
 Html bobswift
&gt;
		&lt;
vertexY
 Html bobswift
&gt;429&lt;
/vertexY
 Html bobswift&gt;
	&lt;/workflowVertex&gt;
&lt;/workflowVertices&gt;
 </pre>
<vertexId>6</vertexId>
		<vertexX>252.5</vertexX>
		<vertexY>429</vertexY>
	</workflowVertex>
</workflowVertices>
 


panel<pre>
[
  {
  "
alias
": "Task 1",
  "
task
": {
    "sysId": "1010f538c0a801c900e0fe0af94d9be5",
    "value": "task1"
  },
  "
vertexId
": "5",
  "
vertexX
": "253",
  "
vertexY
": "296"
  },
  {
  "
alias
": "Task 2",
  "
task
": {
    "sysId": "f81d30ccc0a801c9008ea20e4f5f61d6",
    "value": "task2"
  },
  "
vertexId
": "6",
  "
vertexX
": "252.5",
  "
vertexY
": "429"
  }
]

 </pre>
 Expand
titleJSON
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift

 Anchor
List Tasks in a Workflow Response Properties
List Tasks in a Workflow Response Properties
List Tasks in a Workflow: Response Properties
...
 Anchor
Modify a Dependency in a Workflow Example Request
Modify a Dependency in a Workflow Example Request
Modify a Dependency in a Workflow: Example Request
&gt;
<condition>Success</condition>
      
&lt;
points
&gt;
<points>
            
&lt;point
<point x="280" y="300" /
&gt;
>
      
&lt;
</points
&gt;
>
      
&lt;
sourceId
     
XML
JSON

<pre>
&lt;workflowEdge&gt;
<workflowEdge>
      
 &lt;
condition
 Expand
titleXML
 Panel
 Html bobswift
 Html bobswift
&gt;Success&lt;
/condition
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
&gt;2&lt;
/sourceId
 Html bobswift&gt;
<sourceId>2</sourceId>
      
&lt;
straightEdge
 Html bobswift
&gt;false&lt;
/straightEdge
 Html bobswift&gt;
<straightEdge>false</straightEdge>
      
&lt;
targetId
 Html bobswift
&gt;3&lt;
/targetId
 Html bobswift&gt;
&lt;/workflowEdge&gt;
<targetId>3</targetId>
</
pre>
workflowEdge>


<pre>
{
  "
condition
": {
     "value": "Success"
  },
  "
points
": [ {
     "x": "280",
     "y": "300"
  } ],
  "
sourceId
": {
    "value": "2"
  },
  "
straightEdge
": false,
  "
targetId
": {
    "value": "3"
  }
}

</pre>
 Expand
titleJSON
 Panel
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift

 Anchor
Modify a Task in a Workflow
Modify a Task in a Workflow
Modify a Task in a Workflow
...
 Anchor
Modify a Task in a Workflow Example Request
Modify a Task in a Workflow Example Request
Modify a Task in a Workflow: Example Request
&gt;
<alias>S30</alias>
      
&lt;
task
     
XML
JSON

<pre>
&lt;workflowVertex&gt;
<workflowVertex>
      
  &lt;
alias
 Expand
titleXML
 Panel
 Html bobswift
 Html bobswift
&gt;S30&lt;
/alias
 Html bobswift
 Html bobswift
&gt;Sleep 30&lt;
/task
 Html bobswift&gt;
<task>Sleep 30</task>
      
&lt;
vertexX
 Html bobswift
&gt;360&lt;
/vertexX
 Html bobswift&gt;
<vertexX>360</vertexX>
      
 &lt;
vertexY
 Html bobswift
&gt;60&lt;
/vertexY
 Html bobswift&gt;
&lt;/workflowVertex&gt;
</pre>
<vertexY>60</vertexY>
</workflowVertex>


panel<pre>
{
  "
alias
": "S30",
  "
task
": {
    "value": "sleep 30"
  },
  "
vertexX
": "360",
  "
vertexY
": "60"
}

</pre>
 Expand
titleJSON
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift

 Anchor
Modify a Task in a Workflow Properties
Modify a Task in a Workflow Properties
Modify a Task in a Workflow: Properties
...
 Anchor
Remove Task(s) from a Workflow Example Response
Remove Task(s) from a Workflow Example Response
Remove Task(s) from a Workflow: Example Response
<alias>Task 1</alias>
		<task sysId="1010f538c0a801c900e0fe0af94d9be5"
&gt;task1&lt;
/task
     
XML
JSON

<pre>
&lt;workflowVertices&gt;
	&lt;workflowVertex&gt;
<workflowVertices>
	<workflowVertex>
		
&lt;
alias
 Expand
titleXML
 Panel
 Html bobswift
 Html bobswift
&gt;Task 1&lt;
/alias
 Html bobswift
&gt;
		&lt;
task
 Html bobswift
 Html bobswift
&gt;
		&lt;
vertexId
 Html bobswift
&gt;5&lt;
/vertexId
 Html bobswift
&gt;
		&lt;
vertexX
 Html bobswift
&gt;253&lt;
/vertexX
 Html bobswift
&gt;
		&lt;
vertexY
 Html bobswift
&gt;296&lt;
/vertexY
 Html bobswift&gt;
	 &lt;/workflowVertex&gt;
&lt;/workflowVertices&gt; 
</pre>
>task1</task>
		<vertexId>5</vertexId>
		<vertexX>253</vertexX>
		<vertexY>296</vertexY>
	 </workflowVertex>
</workflowVertices> 


panel<pre>
[ {
  "
alias
": "task 1",
  "
task
": {
    "sysId": "1010f538c0a801c900e0fe0af94d9be5",
    "value": "task1"
  "
vertexId
": "5",
  "
vertexX
": "253",
  "
vertexY
": "296"
} ]

</pre>
 Expand
titleJSON
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift


 Note
titleNote
If there are no matching tasks to remove, an empty list is returned.
...