Versions Compared

Old Version 2

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 3

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
Table of Contents
maxlevel1

Anchor
Overview
Overview
Overview

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

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

Anchor
Add a Dependency to a Workflow
Add a Dependency to a Workflow
Add a Dependency to a Workflow


Description

URI

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

HTTP Method

POST

Description

Adds a dependency to a workflow, with the dependency represented by a workflowEdge. (See Example Request, below.)

URI Parameters

See Add a Dependency to a Workflow: URI Parameters, below.

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 Add a Dependency to a Workflow: Example Request, below.

Add a Dependency to a Workflow Properties

See Add a Dependency to a Workflow: Properties, below.

Example Response

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

Anchor
Add a Dependency to a Workflow URI Parameters
Add a Dependency to a Workflow URI Parameters
Add a Dependency to 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
Add a Dependency to a Workflow Example Request
Add a Dependency to a Workflow Example Request
Add a Dependency to a Workflow: Example Request

XML

JSON

Expand
titleXML
Panel

condition

/condition

points

/points

sourceId

/sourceId

straightEdge

/straightEdge

targetId

/targetId

Expand
titleJSON
Panel

condition

points

sourceId

straightEdge

targetId

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

Panel

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

Anchor
Add a Task to a Workflow
Add a Task to a Workflow
Add a Task to a Workflow


Description

URI

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

HTTP Method

POST

Description

Adds a task to a workflow, with the task represented by a workflowVertex. (See Example Request, below.)

URI Parameters

See Add a Task to a Workflow: URI Parameters, below.

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Add a Task to a Workflow: Example Request, below.

Example Response

See Add a Task to a Workflow: Example Response (Status 200), below.

Add a Task to a Workflow Properties

See Add a Task to a Workflow: Request/Response Properties, below.

Example Response

  • Status 200 /OK
    Successfully added vertex with vertexId <vertextId>.
  • Status 400 /Bad Request
    Workflow <workflowName> doesn`t exist.

Anchor
Add a Task to a Workflow URI Parameters
Add a Task to a Workflow URI Parameters
Add a Task to 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
Add a Task to a Workflow Example Request
Add a Task to a Workflow Example Request
Add a Task to a Workflow: Example Request

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

Property

UI Field Name

Description

Anchor
alias - ATW
alias - ATW
alias

n/a

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

Anchor
task - ATW
task - ATW
task

Task Name

Name of the task added to the workflow.

Anchor
vertexId - ATW
vertexId - ATW
vertexId

n/a

Vertex ID of the task added to the workflow.
 
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 added to the workflow.

Anchor
vertexY - ATW
vertexY - ATW
vertexY

n/a

y-coordinate of the task added to the workflow.

Anchor
List Dependencies in a Workflow
List Dependencies in a Workflow
List Dependencies in a Workflow


Description

URI

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

HTTP Method

GET

Description

Returns the list of dependencies for all tasks in a workflow, with each dependency represented by a workflowEdge (see Example Response, below).

URI Parameters

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

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

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

Response Properties

See List Dependencies in a Workflow: Properties, below.

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

Name

Description

Specifications

Required

Mutually Exclusive With

sourceid

Vertex ID of the source task.

String; URI parameter.

N


targetid

Vertex ID of the target task.

String; URI parameter.

N


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
List Dependencies in a Workflow Example Response
List Dependencies in a Workflow Example Response
List Dependencies in a Workflow: Example Response

XML

JSON

Expand
titleXML
Panel

condition

/condition

sourceId

/sourceId

straightEdge

/straightEdge

targetId

/targetId

condition

/condition

sourceId

/sourceId

straightEdge

/straightEdge

targetId

/targetId

Expand
titleJSON
Panel

condition

sourceId

straightEdge

targetId

condition

sourceId

straightEdge

targetId

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

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.

String; URI parameter.

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
Panel

alias

/alias

task

/task

vertexId

/vertexId

vertexX

/vertexX

vertexY

/vertexY

alias

/alias

task

/task

vertexId

/vertexId

vertexX

/vertexX

vertexY

/vertexY

Expand
titleJSON
Panel

alias

task

vertexId

vertexX

vertexY

alias

task

vertexId

vertexX

vertexY

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
Panel

condition

/condition

points

/points

sourceId

/sourceId

straightEdge

/straightEdge

targetId

/targetId

Expand
titleJSON
Panel

condition

points

sourceId

straightEdge

targetId

Anchor
Modify a Task in a Workflow
Modify a Task in a Workflow
Modify a Task in a Workflow


Description

URI

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

HTTP Method

PUT

Description

Modifies a task in a workflow, with the task represented by a workflowVertex.

URI Parameters

See Modify a Task in a Workflow: URI Parameters, below.

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

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

Modify a Task in a Workflow Properties

See Add a Task to a Workflow: Properties.

Anchor
Modify a Task in a Workflow URI Parameters
Modify a Task in a Workflow URI Parameters
Modify a Task 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 Task in a Workflow Example Request
Modify a Task in a Workflow Example Request
Modify a Task in a Workflow: Example Request

XML

JSON

Expand
titleXML
Panel

alias

/alias

task

/task

vertexX

/vertexX

vertexY

/vertexY

Expand
titleJSON
Panel

alias

task

vertexX

vertexY

Anchor
Modify a Task in a Workflow Properties
Modify a Task in a Workflow Properties
Modify a Task in a Workflow: Properties

Property

UI Field Name

Description

Specifications

Required

Anchor
alias - MTW
alias - MTW
alias

n/a

Alias used for the task to be modified in the workflow; specifically, the value of ops_task_workflow_vertex.name.


N

Anchor
task - MTW
task - MTW
task

Task Name

Name of the task to be modified in the workflow.

Cannot be modified; used only to search for the task. To modify by task, the task must be unique in the workflow.
 
If both task and vertextId are specified, vertextId is used to search for the task to be modified.

Y
(unless vertextid
is specified.)

Anchor
vertexId - MTW
vertexId - MTW
vertexId

n/a

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

Cannot be modified; used only to search for the task.
 
If both task and vertextId are specified, vertextId is used to search for the task to be modified.

Y
(unless task
is specified.)

Anchor
vertexX - MTW
vertexX - MTW
vertexX

n/a

x-coordinate of the task to be modified in the workflow.

Default is 0.

N

Anchor
vertexY - MTW
vertexY - MTW
vertexY

n/a

y-coordinate of the task to be modified in the workflow.

Default is 0.

N

Anchor
Remove a Dependency from a Workflow
Remove a Dependency from a Workflow
Remove a Dependency from a Workflow


Description

URI

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

HTTP Method

DELETE

Description

Removes a dependency from a workflow, with the dependency represented by sourceid and targetid (see Example Response, below).

URI Parameters

See Remove a Dependency from a Workflow: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/workflow/edges?workflowname=workflow1&sourceid=2&targetid=4

Authentication

HTTP Basic

Example Response

  • Status 200 /OK
    Successfully updated vertex with vertex id <vertexId>.
  • Status 400 /Bad Request
    Workflow <workflowName> doesn`t exist.

Anchor
Remove a Dependency from a Workflow URI Parameters
Remove a Dependency from a Workflow URI Parameters
Remove a Dependency from a Workflow: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
sourceid - DDW
sourceid - DDW
sourceid

Vertex ID of the source task.

Integer; URI parameter.

Y


Anchor
targetid - DDW
targetid - DDW
targetid

Vertex ID of the target task.

Integer; URI parameter.

Y


Anchor
workflowid - DDW
workflowid - DDW
workflowid

ID used within the Controller to identify a workflow.

String; URI parameter.

Y
(unless workflowname
is specified.

workflowname

Anchor
workflowname - DDW
workflowname - DDW
workflowname

Name used within the Controller to identify a workflow.

String; URI parameter.

Y
(unless workflowid
is specified.

workflowid

Anchor
Remove Task(s) from a Workflow
Remove Task(s) from a Workflow
Remove Task(s) from a Workflow


Description

URI

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

HTTP Method

DELETE

Description

Removes one or more tasks from a workflow, with each removed task represented by a workflowVertex (see Example Response, below).

URI Parameters

See Remove Task(s) from a Workflow: URI Parameters, below.

Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Authentication

HTTP Basic

Example Response

See Remove Task(s) from a Workflow: Example Response, below.

Remove Task(s) from a Workflow Properties

See Remove Task(s) from a Workflow: Properties, below.

Anchor
Remove Task(s) from a Workflow URI Parameters
Remove Task(s) from a Workflow URI Parameters
Remove Task(s) from a Workflow: URI Parameters

If taskid, taskname, or taskalias is specified, all tasks matching the taskid, taskname, or taskalias - and their dependencies - are removed.

If vertexid is specified, only the task with that specific Vertex ID - and its dependencies - is removed.
 

Parameter

Description

Specifications

Required

Mutually Exclusive With

Anchor
taskalias - DTW
taskalias - DTW
taskalias

Alias of the task(s) to be removed from 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 - DTW
taskid - DTW
taskid

SysId of the task(s) to be removed from the Workflow.

String; URI parameter.

Y
(unless taskalias,
taskname or vertexid,
is specified

taskalias,
taskname,
vertexid

Anchor
taskname - DTW
taskname - DTW
taskname

Name of the task(s) to be removed from the Workflow.

String; URI parameter.

Y
(unless taskalias,
taskid or vertexid,
is specified

taskalias,
taskid,
vertexid

Anchor
vertexid - DTW
vertexid - DTW
vertexid

Vertex ID of the task to be removed from the workflow.
 
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

Anchor
workflowid - DTW
workflowid - DTW
workflowid

ID used within the Controller to identify a workflow.

String; URI parameter.

Y
(unless workflowname
is specified.

workflowname

Anchor
workflowname - DTW
workflowname - DTW
workflowname

Name used within the Controller to identify a workflow.

String; URI parameter.

Y
(unless workflowid
is specified.

workflowid

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

Expand
titleXML
Panel

alias

/alias

task

/task

vertexId

/vertexId

vertexX

/vertexX

vertexY

/vertexY

Expand
titleJSON
Panel

alias

task

vertexId

vertexX

vertexY

Note
titleNote

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

Anchor
Remove Task(s) from a Workflow Response Properties
Remove Task(s) from a Workflow Response Properties
Remove Task(s) from a Workflow: Response Properties

This response contains a list of tasks removed from a workflow
 

Property

UI Field Name

Description

Anchor
alias - DTW
alias - DTW
alias

n/a

Alias of the task removed from the Workflow; specifically, the value of ops_task_workflow_vertex.name.

Anchor
task - DTW
task - DTW
task

Task Name

Name of the task removed from the Workflow.

Anchor
vertexId - DTW
vertexId - DTW
vertexId

n/a

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

Anchor
vertexX - DTW
vertexX - DTW
vertexX

n/a

x-coordinate of the task removed from the Workflow.

Anchor
vertexY - DTW
vertexY - DTW
vertexY

n/a

y-coordinate of the task removed from the Workflow.