Page Comparison

...

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

...

	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.

...

	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.

...

XML

JSON

Expand

title	XML

<workflowVertex>
      <alias>S30</alias>
      <conditionExpression />
      <task>Sleep 30</task>
      <vertexX>360</vertexX>
      <vertexY>60</vertexY>
</workflowVertex>

Expand

title	JSON

{
  "alias": "S30",
  "conditionExpression": null,
  "task": {
    "value": "Sleep 30"
  }, 
  "vertexX": "360",
  "vertexY": "60"
}

...

XML

JSON

Expand

title	XML

<workflowVertex>
      <alias>S30</alias>
      <conditionExpression />
      <task>Sleep 30</task>
      <vertexId>9</vertexId>
      <vertexX>360</vertexX>
      <vertexY>60</vertexY>
</workflowVertex>

Expand

title	JSON

{
  "alias": "S30",
  "conditionExpression": null,
  "task": {
    "value": "Sleep 30"
  }, 
  "vertexId": "9,
  "vertexX": "360",
  "vertexY": "60"
}

...

task task task

Property

UI Field Name

Description

Specification

Required

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.

N

Anchor

conditionExpression - ATW

Task Name

Name of the task added to the workflow.

Anchor

conditionExpression

n/a

Boolean condition expression to specify the dependency criteria.

XML:

<conditionExpression>
    <condition>
        <vertexId>7</vertexId>
    </condition>
    <condition>
        <vertexId>10</vertexId>
    </condition>
    <compoundCondition>
        <condition>
            <vertexId>9</vertexId>
        </condition>
        <condition>
            <vertexId>7</vertexId>
        </condition>
        <logicalOperator>And</logicalOperator>
    </compoundCondition>
    <logicalOperator>Or</logicalOperator>
</conditionExpression>

JSON:

"conditionExpression": {
    "conditions": [
        {
            "type": "condition",
            "vertexId": "7"
        },
        {
            "type": "condition",
            "vertexId": "10"
        },
        {
            "type": "compoundCondition",
            "conditions": [
                {
                    "type": "condition",
                    "vertexId": "9"
                },
                {
                    "type": "condition",
                    "vertexId": "7"
                }
            ],
        "logicalOperator": "And"
        }
    ],
    "logicalOperator": "Or"
}

N

Anchor

	task - ATW
	task - ATW

task

Task Name

Name of the task added to the workflow.

Y

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.

Y

Anchor

	vertexX - ATW
	vertexX - ATW

vertexX

n/a

x-coordinate of the task added to the workflow.

Default is 0.

N

Anchor

	vertexY - ATW
	vertexY - ATW

vertexY

n/a

y-coordinate of the task added to the workflow.

Default is 0.

N

Anchor

	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

...

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

	List Tasks in a Workflow URI Parameters
	List Tasks in a Workflow URI Parameters

...

	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.

...

	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

...

	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.

...

	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	http://localhost:8080/uc/resources/workflow/vertices?workflowname=workflow1&vertexid=2 http://localhost:8080/uc/resources/workflow/vertices?workflowname=workflow1&taskname=task1 http://localhost:8080/uc/resources/workflow/vertices?workflowname=workflow1&taskalias=Task1
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

...

Versions Compared

Old Version 2

New Version 3

Key