Versions Compared

Key

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

...

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

XML

JSON

Property

UI Field Name

Description

Specifications

Required

Anchor
condition - ADWcondition - ADW

n/a

Dependency condition

...

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


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

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:Default is

  • Success
.
 
For example:
 
   <condition>Success</condition>
   <condition>Failure</condition>
   <condition>Success/Failure</condition>
  • Failure
  • Success/Failure
  • Exit Code; Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30
  • Step Condition; Format: step:procedure:program:condition codes. Example: *:*:*:JCLERR
  • Variable

Default is Success.
 
For example:
 
   <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>
 
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:
 

Panel

N

<points>
	<point x="280" y="300" />
</points>


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

XML

JSON

...

Parameter

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

Alias used for the task within the Workflow; specifically, the value of ops_task_workflow_vertex.name.

...

String; URI parameter.

...

Y
(unless taskid,
taskname or vertexid,
is specified

...

taskid,
taskname,
vertexid

...

ID used within the Controller to identify this task.

...

String; URI parameter.

...

Y
(unless taskalias,
taskname or vertexid,
is specified

...

taskalias,
taskname,
vertexid

...

Name used within the Controller to identify this task.

...

String; URI parameter.

...

Y
(unless taskalias,
taskid or vertexid,
is specified

...

taskalias,
taskid,
vertexid

...

Vertex ID of the task in the workflow to be listed.
 
Each task within a Workflow has a unique Vertex ID to distinguish it from other tasks, if any, of the same name.

...

String; URI parameter.

...

Y
(unless taskalias,
taskid or taskname,
is specified

...

taskalias,
taskid,
taskname

...

ID used within the Controller to identify a workflow.

...

Y
(unless workflowname
is specified

...

workflowname

...

Name of a workflow.

...

Y
(unless workflowid
is specified

...

workflowid

...

XML

...

JSON

...

...

...

aliastaskvertexId

Property

UI Field Name

Description

Anchor
alias - ATWalias - ATW

n/a

Alias used for the task; specifically, the value of ops_task_workflow_vertex.name.

Anchor
task - ATWtask - ATW

Task Name

Name of the task added.

Anchor
vertexId - ATWvertexId - ATW

n/a

Vertex ID of the task.
 

...

Property

...

UI Field Name

...

Description

...

n/a

...

Dependency condition between the source and target tasks of this edge (connector).

...

n/a

...

Vertex ID of the source task.

...

n/a

...

Specification for whether the edge is straight or bent.

...

n/a

...

Vertex ID of the target task.

...

Attribute sysId identifies the sysid of the specified task.

...

Description

...

URI

...

HTTP Method

...

GET

...

Description

...

Returns the list of tasks in a workflow, with each task represented by a workflowVertex (see Example Response, below).

...

URI Parameters

...

See List Tasks in a Workflow: URI Parameters, below.

...

Example URI

...

...

Authentication

...

HTTP Basic

...

Consumes Content-Type

...

n/a

...

Produces Content-Type

...

application/xml, application/json

...

Example Response

...

See List Tasks in a Workflow: Example Response, below.

...

Response Properties

...

See List Tasks in a Workflow: Properties, below.

<workflowEdges>
        <workflowEdge>
                 <condition>Success</condition>
                 <sourceId taskName="Sleep 30" taskAlias="test">2</sourceId>
                 <straightEdge>true</straightEdge>
                 <targetId taskName="Sleep 60">3</targetId>
        </workflowEdge>
        <workflowEdge>
                 <condition>Success</condition>
                 <sourceId taskName="Sleep 60">3</sourceId>
                 <straightEdge>true</straightEdge>
                 <targetId taskName="Sleep 60">6</targetId>
        </workflowEdge>
</workflowEdges> 



Expand
titleJSON
[
  {
  "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"
  }
} 
]


Anchor
List Dependencies in a Workflow Properties
List Dependencies in a Workflow Properties
List Dependencies in a Workflow: Properties

Property

UI Field Name

Description

Anchor
condition - LTE
condition - LTE
condition

n/a

Dependency condition between the source and target tasks of this edge (connector).

Anchor
sourceId - LTE
sourceId - LTE
sourceId

n/a

Vertex ID of the source task.

Anchor
straightEdge - LTE
straightEdge - LTE
straightEdge

n/a

Specification for whether the edge is straight or bent.

Anchor
targetId - LTE
targetId - LTE
targetId

n/a

Vertex ID of the target task.

Anchor
List Tasks in a Workflow
List Tasks in a Workflow
List Tasks in a Workflow

Attribute sysId identifies the sysid of the specified task.


Description

URI

http://host_name/uc/resources/workflow/vertices

HTTP Method

GET

Description

Returns the list of tasks in a workflow, with each task represented by a workflowVertex (see Example Response, below).

URI Parameters

See List Tasks in a Workflow: URI Parameters, below.

Example URI

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List Tasks in a Workflow: Example Response, below.

Response Properties

See List Tasks in a Workflow: Properties, below.

Anchor
List Tasks in a Workflow URI Parameters
List Tasks in a Workflow URI Parameters
List Tasks in a Workflow: URI Parameters

vertexXvertexY

Parameter

Description

Specifications

Required

Mutually Exclusive With

Anchor
taskalias - LTW
taskalias - LTW
taskalias

Alias used for the task within the Workflow; specifically, the value of ops_task_workflow_vertex.name.

String; URI parameter.

Y
(unless taskid,
taskname or vertexid,
is specified

taskid,
taskname,
vertexid

Anchor
taskid - LTW
taskid - LTW
taskid

ID used within the Controller to identify this task.

String; URI parameter.

Y
(unless taskalias,
taskname or vertexid,
is specified

taskalias,
taskname,
vertexid

Anchor
taskname - LTW
taskname - LTW
taskname

Name used within the Controller to identify this task.

String; URI parameter.

Y
(unless taskalias,
taskid or vertexid,
is specified

taskalias,
taskid,
vertexid

Anchor
vertexid - LTW
vertexid - LTW
vertexid

Vertex ID of the task in the workflow to be listed.
 
Each task within a Workflow has a unique Vertex ID to distinguish it from other tasks, if any, of the same name, if any.

Anchor
vertexX - ATWvertexX - ATW

n/a

x-coordinate of the task.

Anchor
vertexY - ATWvertexY - ATW

n/a

y-coordinate of the task.

...

Description

...

URI

...

HTTP Method

...

PUT

...

Description

...

Modifies a dependency in a workflow, with the dependency represented by a workflowEdge.

...

URI Parameters

...

See Modify a Dependency in a Workflow: URI Parameters.

...

Example URI

...

Consumes Content-Type

...

application/xml, application/json

...

Produces Content-Type

...

n/a

...

Example Request

...

See Modify a Dependency in a Workflow: Example Request, below.

...

Modify a Dependency in a Workflow Properties

...

See Add a Dependency to a Workflow: Properties.

...

Example Response

...

  • Status 200 /OK
    Successfully updated dependency between <sourceId> and <targetId>.
  • Status 400 /Bad Request
    Workflow <workflowName> doesn`t exist.

...

Name

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

workflowid

...

ID used within the Controller to identify the workflow.

...

String; URI parameter.

...

Y
(unless workflowname
is specified)

...

workflowname

...

workflowname

...

Name used within the Controller to identify the workflow.

...

String; URI parameter.

...

Y
(unless workflowid
is specified)

...

workflowid

...

condition

points

sourceId

straightEdge

targetId

String; URI parameter.

XML

JSON

Expand
titleJSON
Panel

Y
(unless taskalias,
taskid or taskname,
is specified

taskalias,
taskid,
taskname

Anchor
workflowid - LTW
workflowid - LTW
workflowid

ID used within the Controller to identify a workflow.


Y
(unless workflowname
is specified

workflowname

Anchor
workflowname - LTW
workflowname - LTW
workflowname

Name of a workflow.


Y
(unless workflowid
is specified

workflowid

Anchor
List Task in a Workflow Example Response
List Task in a Workflow Example Response
List Tasks in a Workflow: Example Response

XML

JSON


Expand
titleXML
<workflowVertices>
	<workflowVertex>
		<alias>Task 1</alias>
		<task sysId="1010f538c0a801c900e0fe0af94d9be5">task1</task>
		<vertexId>5</vertexId>
		<vertexX>253</vertexX>
		<vertexY>296</vertexY>
	</workflowVertex>
	<workflowVertex>
		<alias>Task 2</alias>
		<task sysId="f81d30ccc0a801c9008ea20e4f5f61d6">task2</task>
		<vertexId>6</vertexId>
		<vertexX>252.5</vertexX>
		<vertexY>429</vertexY>
	</workflowVertex>
</workflowVertices>



Expand
titleJSON
[
  {
  "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"
  }
]


Anchor
List Tasks in a Workflow Response Properties
List Tasks in a Workflow Response Properties
List Tasks in a Workflow: Response Properties

Property

UI Field Name

Description

Anchor
alias - ATW
alias - ATW
alias

n/a

Alias used for the task; specifically, the value of ops_task_workflow_vertex.name.

Anchor
task - ATW
task - ATW
task

Task Name

Name of the task added.

Anchor
vertexId - ATW
vertexId - ATW
vertexId

n/a

Vertex ID of the task.
 
Each task within a Workflow has a unique Vertex ID to distinguish it from other tasks of the same name, if any.

Anchor
vertexX - ATW
vertexX - ATW
vertexX

n/a

x-coordinate of the task.

Anchor
vertexY - ATW
vertexY - ATW
vertexY

n/a

y-coordinate of the task.

Anchor
Modify a Dependency in a Workflow
Modify a Dependency in a Workflow
Modify a Dependency in a Workflow


Description

URI

http://host_name/uc/resources/workflow/edges

HTTP Method

PUT

Description

Modifies a dependency in a workflow, with the dependency represented by a workflowEdge.

URI Parameters

See Modify a Dependency in a Workflow: URI Parameters.

Example URI

http://localhost:8080/uc/resources/workflow/edges?workflowname=workflow1

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Modify a Dependency in a Workflow: Example Request, below.

Modify a Dependency in a Workflow Properties

See Add a Dependency to a Workflow: Properties.

Example Response

  • Status 200 /OK
    Successfully updated dependency between <sourceId> and <targetId>.
  • Status 400 /Bad Request
    Workflow <workflowName> doesn`t exist.

Anchor
Modify a Dependency in a Workflow URI Parameters
Modify a Dependency in a Workflow URI Parameters
Modify a Dependency in a Workflow: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

workflowid

ID used within the Controller to identify the workflow.

String; URI parameter.

Y
(unless workflowname
is specified)

workflowname

workflowname

Name used within the Controller to identify the workflow.

String; URI parameter.

Y
(unless workflowid
is specified)

workflowid

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

XML

JSON


Expand
titleXML
<workflowEdge>
      <condition>Success</condition>
      <points>
            <point x="280" y="300" />
      </points>
      <sourceId>2</sourceId>
      <straightEdge>false</straightEdge>
      <targetId>3</targetId>
</workflowEdge>



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


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

XML

JSON


alias

/alias

task

/task

vertexX

/vertexX

vertexY

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



alias

task

vertexX

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


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

XML

JSON


alias

task

vertexId

vertexX

vertexY
Expand
titleXML
Panel

alias

/alias

task

/task

vertexId

/vertexId

vertexX

/vertexX

vertexY

/vertexY

Expand
titleJSON
Panel
<workflowVertices>
	<workflowVertex>
		<alias>Task 1</alias>
		<task sysId="1010f538c0a801c900e0fe0af94d9be5">task1</task>
		<vertexId>5</vertexId>
		<vertexX>253</vertexX>
		<vertexY>296</vertexY>
	 </workflowVertex>
</workflowVertices> 



Expand
titleJSON
[ {
  "alias": "task 1",
  "task": {
    "sysId": "1010f538c0a801c900e0fe0af94d9be5",
    "value": "task1"
  "vertexId": "5",
  "vertexX": "253",
  "vertexY": "296"
} ]



Note
titleNote

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

...