Workflow Task and Dependency Web Services
Overview
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.
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 |
|
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 |
|
Add a Dependency to a Workflow: Example Request
XML | JSON |
---|---|
Add a Dependency to a Workflow: Request Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| n/a | Dependency condition between the source and target tasks of this dependency (connector). | Valid values:
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 |
| n/a | If | For example: <points> <point x="280" y="300" /> </points> | 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 |
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 |
|
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 |
|
Add a Task to a Workflow: Example Request
XML | JSON |
---|---|
Add a Task to a Workflow: Example Response (Status 200)
XML | JSON |
---|---|
Add a Task to a Workflow: Request/Response Properties
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. |
| n/a | x-coordinate of the task added to the workflow. |
| n/a | y-coordinate of the task added to the 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 |
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. |
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 |
|
List Dependencies in a Workflow: Example Response
XML | JSON |
---|---|
List Dependencies in a Workflow: Properties
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. |
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. |
List Tasks in a Workflow: URI Parameters
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 |
|
| ID used within the Controller to identify this task. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this task. | String; URI parameter. | Y |
|
| Vertex ID of the task in the workflow to be listed. | String; URI parameter. | Y |
|
| ID used within the Controller to identify a workflow. | Y |
| |
| Name of a workflow. | Y |
|
List Tasks in a Workflow: Example Response
XML | JSON |
---|---|
List Tasks in a Workflow: Response Properties
Property | UI Field Name | Description |
---|---|---|
| n/a | Alias used for the task; specifically, the value of ops_task_workflow_vertex.name. |
| Task Name | Name of the task added. |
| n/a | Vertex ID of the task. |
| n/a | x-coordinate of the task. |
| n/a | y-coordinate of the task. |
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 |
|
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 |
|
Modify a Dependency in a Workflow: Example Request
XML | JSON |
---|---|
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 |
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 |
|
Modify a Task in a Workflow: Example Request
XML | JSON |
---|---|
Modify a Task in a Workflow: Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| n/a | Alias used for the task to be modified in the workflow; specifically, the value of ops_task_workflow_vertex.name. | N | |
| 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 |
| n/a | Vertex ID of the task within the workflow. | Cannot be modified; used only to search for the task. | Y |
| n/a | x-coordinate of the task to be modified in the workflow. | Default is 0. | N |
| n/a | y-coordinate of the task to be modified in the workflow. | Default is 0. | N |
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 |
|
Remove a Dependency from a Workflow: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Vertex ID of the source task. | Integer; URI parameter. | Y | |
| Vertex ID of the target task. | Integer; URI parameter. | Y | |
| ID used within the Controller to identify a workflow. | String; URI parameter. | Y |
|
| Name used within the Controller to identify a workflow. | String; URI parameter. | Y |
|
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. |
Remove Task(s) from a Workflow: URI Parameters
If taskid
, taskname
, or taskalias