...
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
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 |
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 |
|
Anchor | ||||
---|---|---|---|---|
|
Add a Dependency to a Workflow: URI Parameters
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 | ||||
---|---|---|---|---|
|
Add a Dependency to a Workflow: Example Request
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Add a Dependency to a Workflow: Request Properties
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 | ||||
---|---|---|---|---|
|
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 |
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 |
|
Anchor | ||||
---|---|---|---|---|
|
Add a Task to a Workflow: URI Parameters
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 | ||||
---|---|---|---|---|
|
Add a Task to a Workflow: Example Request
XML | JSON |
---|---|
Anchor | ||||
---|---|---|---|---|
|
Add a Task to a Workflow: Example Response (Status 200)
XML | JSON |
---|---|
Anchor | ||||
---|---|---|---|---|
|
Add a Task to a Workflow: Request/Response Properties
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. | ||||||
vertexId | n/a | Vertex ID of the task added to the workflow. | ||||||
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 | ||||
---|---|---|---|---|
|
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 |
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
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Vertex ID of the source task. | String; URI parameter. | N | |
| Vertex ID of the target task. | String; URI parameter. | N | |
| 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 | ||||
---|---|---|---|---|
|
List Dependencies in a Workflow: Example Response
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
List Dependencies in a Workflow: Properties
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 | ||||
---|---|---|---|---|
|
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 |
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
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. | String; URI parameter. | Y |
| ||||||
workflowid | ID used within the Controller to identify a workflow. | Y |
| |||||||
workflowname | Name of a workflow. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
List Tasks in a Workflow: Example Response
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
List Tasks in a Workflow: Response Properties
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 | ||||
---|---|---|---|---|
|
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 |
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 | ||||
---|---|---|---|---|
|
Modify a Dependency in a Workflow: URI Parameters
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 | ||||
---|---|---|---|---|
|
Modify a Dependency in a Workflow: Example Request
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
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 |
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 |
Anchor | ||||
---|---|---|---|---|
|
Modify a Task in a Workflow: URI Parameters
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 | ||||
---|---|---|---|---|
|
Modify a Task in a Workflow: Example Request
XML | JSON |
---|---|
Anchor | ||||
---|---|---|---|---|
|
Modify a Task in a Workflow: Properties
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
alias | n/a | Alias used for the task to be modified in the workflow; specifically, the value of ops_task_workflow_vertex.name. | N | |||||||
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 | Y | ||||||
vertexId | n/a | Vertex ID of the task within the workflow. | Cannot be modified; used only to search for the task. | Y | ||||||
vertexX | n/a | x-coordinate of the task to be modified in the workflow. | Default is 0. | N | ||||||
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
Description | |
---|---|
URI | http://host_name/uc/resources/workflow/edges |
HTTP Method | DELETE |
Description | Removes a dependency from a workflow, with the dependency represented by |
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 |
|
Anchor | ||||
---|---|---|---|---|
|
Remove a Dependency from a Workflow: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With | ||||||
---|---|---|---|---|---|---|---|---|---|---|
sourceid | Vertex ID of the source task. | Integer; URI parameter. | Y | |||||||
targetid | Vertex ID of the target task. | Integer; URI parameter. | Y | |||||||
workflowid | ID used within the Controller to identify a workflow. | String; URI parameter. | Y |
| ||||||
workflowname | Name used within the Controller to identify a workflow. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
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 |
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
If taskid
, taskname
, or taskalias
is specified, all tasks matching the taskid
, taskname
, or taskalias
- and their dependencies - are removed.
...
Parameter | Description | Specifications | Required | Mutually Exclusive With | ||||||
---|---|---|---|---|---|---|---|---|---|---|
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 |
| ||||||
taskid | SysId of the task(s) to be removed from the Workflow. | String; URI parameter. | Y |
| ||||||
taskname | Name of the task(s) to be removed from the Workflow. | String; URI parameter. | Y |
| ||||||
vertexid | Vertex ID of the task to be removed from the workflow. | String; URI parameter. | Y |
| ||||||
workflowid | ID used within the Controller to identify a workflow. | String; URI parameter. | Y |
| ||||||
workflowname | Name used within the Controller to identify a workflow. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Remove Task(s) from a Workflow: Example Response
XML | JSON |
---|---|
Note | ||
---|---|---|
| ||
If there are no matching tasks to remove, an empty list is returned. |
Anchor | ||||
---|---|---|---|---|
|
Remove Task(s) from a Workflow: Response Properties
This response contains a list of tasks removed from a workflow
...