...
Universal Controller supports the following RESTful-based web services for Workflow Task and Dependency operations, which are listed alphabetically on this page.
- Workflow Task and Dependency Web Services#Add Add a Dependency to a WorkflowWorkflow Task and Dependency Web Services#Add
- Add a Task to a Workflow
- Workflow Task and Dependency Web Services#List List Dependencies in a WorkflowWorkflow Task and Dependency Web Services#List
- List Tasks in a Workflow
- Workflow Task and Dependency Web Services#Modify Modify a Dependency in a WorkflowWorkflow Task and Dependency Web Services#Modify
- Modify a Task in a Workflow
- Workflow Task and Dependency Web Services#Remove Remove a Dependency from a WorkflowWorkflow Task
- and Dependency Web Services#Remove Remove Task(s) from a Workflow
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
Anchor | ||||
---|---|---|---|---|
|
XML | JSON | |||||
---|---|---|---|---|---|---|
|
...
n/a
...
If straightEdge
is false; x and y coordinates of the Edge angles.
For example:
...
N
...
n/a
...
Vertex ID of the source task.
...
Y
...
n/a
...
Specification for whether the edge is straight or bent.
...
Boolean; Valid values: true/false. Default is true.
...
N
...
n/a
...
Vertex ID of the target task.
...
Y
...
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 | |||||||
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 | Successfully added vertex with vertexId <vertextId>. Workflow <workflowName> doesn`t exist.
|
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
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>
Step Condition is valid for z/OS tasks only.
Success/Failure and Failure are not valid for Workflow, Timer, and Manual tasks.
Note | ||
---|---|---|
| ||
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 | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
condition | n/a | Dependency condition between the source and target tasks of this dependency (connector). | Valid values:
| N | |||||||||||||
points | n/a | If | For example:
| N | |||||||||||||
sourceId | n/a | Vertex ID of the source task. | Y | ||||||||||||||
straightEdge | n/a | Specification for whether the edge is straight or bent. | Boolean; Valid values: true/false. Default is true. | N | |||||||||||||
targetId | n/a | Vertex ID of the target task. | Y |
Anchor | ||
---|---|---|
|
...
|
...
...
Description | Specifications | Required | Mutually Exclusive With | |
---|---|---|---|---|
| ID used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
| Name used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
...
URI | http://host_name/uc/resources/workflow/vertices |
HTTP Method | POST |
Description | Adds a task to a workflow, with the task represented by a |
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 |
...
: Example Response (Status 200), below. | |
Add a Task to a Workflow Properties | See Add a Task to a Workflow: Request/Response Properties, below. |
Example |
...
XML
...
JSON
...
Expand | ||
---|---|---|
| ||
<workflowVertex> <alias>S30</alias> <task>Sleep 30</task> <vertexX>360</vertexX> <vertexY>60</vertexY> </workflowVertex> |
...
Expand | ||
---|---|---|
| ||
{ "alias": "S30", "task": { "value": "Sleep 30" }, "vertexX": "360", "vertexY": "60" } |
...
Response |
|
Anchor | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
| Name used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
...
|
...
Request
XML | JSON |
---|---|
Anchor | ||
---|---|---|
|
...
|
...
|
...
|
...
...
Property
...
UI Field Name
...
Description
...
n/a
...
Alias used for the task added to the workflow; specifically, the value of ops_task_workflow_vertex.name.
...
Task Name
...
Name of the task added to the workflow.
...
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.
...
n/a
...
Example Response (Status 200)
XML | JSON |
---|---|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | ||||||
---|---|---|---|---|---|---|---|---|
alias | n/a | Alias used for the task added to the workflow; specifically, the value of ops_task_workflow_vertex.name. | ||||||
task | Task Name | Name of the task added to the workflow. | ||||||
vertexY vertexId | n/a | y-coordinate Vertex ID of the task added to the 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 | |||||||
URI Parameters | See List Dependencies in a Workflow: URI Parameters, below. | |||||||
Example URI | http://localhost:8080 | |||||||
vertexX | n/a | x-coordinate of the task added to the workflow. | ||||||
vertexY | n/a | y-coordinate of the task added to the workflow. |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/workflow/edges?workflowname=workflow1 |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-TypeMethod | GET |
Description | Returns the list of dependencies for all tasks in a workflow, with each dependency represented by a |
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 | ||||
---|---|---|---|---|
|
XML | JSON |
---|
...
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
...
Expand | ||
---|---|---|
| ||
|
...
...
Property | UI Field Name | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Anchor | alias - ATW | alias - ATW | n/a | Alias used for the task; specifically, the value of ops_task_workflow_vertex.name. | ||||||||||||||||||
Anchor | task - ATW | task - ATW | Task Name | Name of the task added. | ||||||||||||||||||
Anchor | vertexId - ATW | vertexId - 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
...
- http://localhost:8080/uc/resources/workflow/vertices?workflowname=workflow
- http://localhost:8080/uc/resources/workflow/vertices?workflowname=workflow&taskname=test
...
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.
...
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
|
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | ||||||
---|---|---|---|---|---|---|---|---|
condition | n/a | Dependency condition between the source and target tasks of this edge (connector). | ||||||
sourceId | n/a | Vertex ID of the source task. | ||||||
straightEdge | n/a | Specification for whether the edge is straight or bent. | ||||||
targetId | n/a | Vertex ID of the target task. |
Anchor | ||||
---|---|---|---|---|
|
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 |
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 | ||||
---|---|---|---|---|
|
Parameter | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
taskalias | Alias used for the task within the Workflow; specifically, the value of ops_task_workflow_vertex.name. | String; URI parameter. | Y |
| |||||||||||||
taskid | ID used within the Controller to identify this task. | String; URI parameter. | Y |
| |||||||||||||
taskname | Name used within the Controller to identify this task. | String; URI parameter. | Y |
| |||||||||||||
vertexid | Vertex ID of the task in the workflow to be listed. Anchor | | vertexX - ATW | vertexX - ATW | n/a | x-coordinate of the task. | |||||||||||
Anchor | vertexY - ATW | vertexY - 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
...
XML | JSON | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Expand | | |||||||||
| ||||||||||
Panel | Y |
| ||||||||
workflowid | ID used within the Controller to identify a workflow. | Y |
| |||||||
workflowname | Name of a workflow. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | ||||||
---|---|---|---|---|---|---|---|---|
alias | n/a | Alias used for the task; specifically, the value of ops_task_workflow_vertex.name. | ||||||
task | Task Name | Name of the task added. | ||||||
vertexId | n/a | Vertex ID of the task. | ||||||
vertexX | n/a | x-coordinate of the task. | ||||||
vertexY | n/a | y-coordinate of the task. |
Anchor | ||||
---|---|---|---|---|
|
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 |
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 | |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
| Name used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
XML | JSON |
---|---|
Anchor | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
XML | JSON |
---|---|
Note | ||
---|---|---|
| ||
If there are no matching tasks to remove, an empty list is returned. |
...