...
Anchor | ||||
---|---|---|---|---|
|
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Property | UI Field Name | Description | Specifications | Required | |||||||
Anchor | condition - ADW | condition - ADW | n/a | Dependency condition
|
...
|
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:Default is
For example: <condition>Success</condition> <condition>Failure</condition> <condition>Success/Failure</condition>
Default is Success.
| N | |||||||||||
points | n/a | If | For example:
| N |
| 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 |
...
XML | JSON |
---|---|
Anchor | ||||
---|---|---|---|---|
|
XML | JSON |
---|---|
Anchor | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
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
...
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.
|
|
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. |
...