Versions Compared

Old Version 3

changes.mady.by.user Jeremey Laprise

Saved on

compared with

New Version Current

changes.mady.by.user Jeremey Laprise

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

XML

JSON


Expand
titleXML
<workflowVertex>

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



Expand
titleJSON
{
  "alias": "S30",

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


...

XML

JSON


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



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


...

Property

UI Field Name

Description

SpecificationRequired

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
conditionExpression - ATW
conditionExpression		n/aBoolean 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

...

XML

JSON


Expand
titleXML
<workflowEdges>
  <workflowEdge>
    <condition>Success</condition>
<workflowEdge>    <sourceId taskName="Sleep 30" taskAlias="test">2</sourceId>
    <straightEdge>true</straightEdge>
    <targetId  <condition>Success</conditiontaskName="Sleep 60">3</targetId>
  </workflowEdge>
  <workflowEdge>
    <condition>Success</condition>
      <sourceId taskName="Sleep 30" taskAlias="test">2<60">3</sourceId>
                 <straightEdge>true</straightEdge>
            
    <targetId taskName="Sleep 60">3<>6</targetId>
        </workflowEdge>
</workflowEdges>



Expand
titleJSON
[
  {
   <workflowEdge>"condition": {
    "value": "Success"
  },
  "sourceId": {
     <condition>Success</condition>"taskAlias": "test",
    "taskName": "Sleep 30",
    "value": "2"
  },
 <sourceId taskName="Sleep 60">3</sourceId>
straightEdge": true,
  "targetId": {
    "taskName": "Sleep 60",
     <straightEdge>true</straightEdge>
                 <targetId taskName="Sleep 60">6</targetId>"value": "3"
  }
     </workflowEdge>
</workflowEdges>
Expand
titleJSON
[
  },
  {
  "condition": {
    "value": "Success"
  },
  "sourceId": {
    "taskAlias": "test",
    "taskName": "Sleep 3060",
    "value": "23"
  },
  "straightEdge": true,
  "targetId": {
    "taskName": "Sleep 60",
    "value": "36"
  }
},
  {
  "condition": {
    "value": "Success"
  },
  "sourceId": {
    "taskName": "Sleep 60",
    "value": "3"
  },
  "straightEdge": true,
  "targetId": {
    "taskName": "Sleep 60",
    "value": "6"
  }
} 
]

...

List Dependencies in a Workflow: Properties

conditionsourceIdstraightEdgetargetId

Property

UI Field Name

Description

Anchor
condition - LTEcondition - LTE

n/a

Dependency condition between the source and target tasks of this edge (connector).

Anchor
sourceId - LTEsourceId - LTE

n/a

Vertex ID of the source task.

Anchor
straightEdge - LTEstraightEdge - LTE

n/a

Specification for whether the edge is straight or bent.

Anchor
targetId - LTEtargetId - LTE

n/a

Vertex ID of the target task
 
]


Anchor
List Dependencies in a Workflow Properties
List Dependencies in a Workflow Properties

List Dependencies in a Workflow: Properties

Property

UI Field Name

Description

Anchor
condition - LTE
condition - LTE
condition

n/a

Dependency condition between the source and target tasks of this edge (connector).

Anchor
sourceId - LTE
sourceId - LTE
sourceId

n/a

Vertex ID of the source task.

Anchor
straightEdge - LTE
straightEdge - LTE
straightEdge

n/a

Specification for whether the edge is straight or bent.

Anchor
targetId - LTE
targetId - LTE
targetId

n/a

Vertex ID of the target task.

Anchor
List Tasks in a Workflow
List Tasks in a Workflow

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 workflowVertex (see Example Response, below).

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
List Tasks in a Workflow URI Parameters

List Tasks in a Workflow

...

: URI Parameters

Parameter

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

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

...

taskaliasAlias used for the task within the Workflow; specifically, the value of ops_task_workflow_vertex.name.workflowidworkflowname

Parameter

Description

Specifications

Required

Mutually Exclusive With

Anchor
taskalias - LTWtaskalias - LTW

Specifications

Required

Mutually Exclusive With

Anchor
taskalias - LTW
taskalias - LTW
taskalias

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

ID used within the Controller to identify this task.

String; URI parameter.

Y
(unless taskalias,
taskname or vertexid,
is specified

taskalias,
taskname,
vertexid

Anchor
taskname - LTW
taskname - LTW
taskname

Name used within the Controller to identify this task.

String; URI parameter.

Y
(unless taskid taskalias,
taskname taskid or vertexid,
is specified

taskidtaskalias,
tasknametaskid,
vertexid

Anchor
taskid vertexid - LTWtaskid
vertexid - LTW
taskidvertexid

ID used within the Controller to identify this taskVertex 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 or vertexid,
is specified

taskalias,
tasknametaskid,
vertexidtaskname

Anchor
taskname workflowid - LTWtaskname
workflowid - LTW
tasknameworkflowid

Name ID used within the Controller to identify this taska workflow.

String; URI parameter.


Y
(unless taskalias,
taskid or vertexid, workflowname
is specified

taskalias,
taskid,
vertexid

workflowname

Anchor
vertexid workflowname - LTWvertexid
workflowname - LTW
vertexidworkflowname

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.

Name of a workflow.


Y
(unless taskalias,
taskid or taskname,
workflowid
is specified

taskalias,
taskid,
taskname

Anchor
workflowid - LTWworkflowid - LTW

ID used within the Controller to identify a workflow.

Y
(unless workflowname
is specified

workflowname

Anchor
workflowname - LTWworkflowname - LTW

Name of a workflow.

Y
(unless workflowid
is specified

workflowid

...

workflowid

Anchor
List Task in a Workflow Example Response
List Task in a Workflow Example Response

List Tasks in a Workflow: Example Response

XML

JSON


Expand
titleXML
<workflowVertices>
  	<workflowVertex>
		    <alias>Task 1</alias>
		<task sysId="
    <conditionExpression />
    <task sysId="1010f538c0a801c900e0fe0af94d9be5">task1</task>
  		  <vertexId>5</vertexId>
    		<vertexX>253</vertexX>
    		<vertexY>296</vertexY>
 	 </workflowVertex>
	  <workflowVertex>
 		   <alias>Task 2</alias>
		
    <conditionExpression />
    <task sysId="f81d30ccc0a801c9008ea20e4f5f61d6">task2</task>
   		 <vertexId>6</vertexId>
		    <vertexX>252.5</vertexX>
  		  <vertexY>429</vertexY>
	  </workflowVertex>
</workflowVertices>



Expand
titleJSON
[
  {
    "alias": "Task 1",
    "taskconditionExpression": {null,
    "sysIdtask": {
      "sysId": "1010f538c0a801c900e0fe0af94d9be5",
      "value": "task1"
    },
    "vertexId": "5",
    "vertexX": "253",
    "vertexY": "296"
    },
    {
    "alias": "Task 2",
    "conditionExpression": null,
    "task": {
      "sysId": "f81d30ccc0a801c9008ea20e4f5f61d6",
      "value": "task2"
    },
    "vertexId": "6",
    "vertexX": "252.5",
    "vertexY": "429"
  }
]


Anchor
List Tasks in a Workflow Response Properties
List Tasks in a Workflow Response Properties

...

Property

UI Field Name

Description

Anchor
alias - ATW
alias - ATW
alias

n/a

Alias used for the task; specifically, the value of ops_task_workflow_vertex.name.

Anchor
conditionExpression - ATW
conditionExpression - ATW
conditionExpression		n/aBoolean condition expression to specify the dependency criteria.

Anchor
task - ATW
task - ATW
task

Task Name

Name of the task added.

Anchor
vertexId - ATW
vertexId - ATW
vertexId

n/a

Vertex ID of the task.
 
Each task within a Workflow has a unique Vertex ID to distinguish it from other tasks of the same name, if any.

Anchor
vertexX - ATW
vertexX - ATW
vertexX

n/a

x-coordinate of the task.

Anchor
vertexY - ATW
vertexY - ATW
vertexY - ATWvertexY

n/a

y-coordinate of the task.

...

n/a

y-coordinate of the task.

Anchor
Modify a Dependency in a Workflow
Modify a Dependency in a Workflow

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

Anchor
Modify a Dependency in a Workflow URI Parameters
Modify a Dependency in a Workflow URI Parameters

Modify a Dependency in a Workflow: URI Parameters

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

Anchor
Modify a Dependency in a Workflow Example Request
Modify a Dependency in a Workflow Example Request

Modify a Dependency in a Workflow: Example Request

XML

JSON


Expand
titleXML
<workflowEdge>
  <condition>Success</condition>
  <points>
    <point x="280" y="300" />
  </points>
  <sourceId>2</sourceId>
  <straightEdge>false</straightEdge>
  <targetId>3</targetId>
</workflowEdge>



Expand
titleJSON
{
  "condition": {
     "value": "Success"
  },
  "points": [ {
     "x": "280",
     "y": "300"
  } ],
  "sourceId": {
    "value": "2"
  },
  "straightEdge": false,
  "targetId": {
    "value": "3"
  }
}


Anchor
Modify a Task in a Workflow
Modify a Dependency Task in a Workflow

Modify a

...

Task in a Workflow


Description

URI

http://host_name/uc/resources/workflow/edgesvertices

HTTP Method

PUT

Description

Modifies a dependency task in a workflow, with the dependency task represented by a workflowEdge workflowVertex.

URI Parameters

See Modify a Dependency Task in a Workflow: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/workflow/edgesvertices?workflowname=workflow1

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Modify a Dependency Task in a Workflow: Example Request, below.

Modify a Dependency Task in a Workflow Properties

See Add a Dependency Task 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.

Anchor
Modify a Dependency Task in a Workflow URI Parameters
Modify a Dependency Task in a Workflow URI Parameters

Modify a

...

Task in a Workflow: URI Parameters

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

Anchor
Modify a Dependency Task in a Workflow Example Request
Modify a Dependency Task in a Workflow Example Request

Modify a

...

Task in a Workflow: Example Request

XML

JSON


Expand
titleXML
<workflowEdge><workflowVertex>
      <condition>Success</condition>
      <points>
            <point x="280" y="300" <alias>S30</alias>
  <conditionExpression />
      </points>
      <sourceId>2</sourceId>
   <task>Sleep 30</task>
  <straightEdge>false<vertexX>360</straightEdgevertexX>
   
  <targetId>3<vertexY>60</targetIdvertexY>
</workflowEdge>workflowVertex>



Expand
titleJSON
{
  "conditionalias": {
     "value": "Success"
  },
"S30",
  "pointsconditionExpression": [ {
     "x": "280",
  null,
  "ytask": "300"
  } ],
  "sourceId": {
    "value": "2sleep 30"
  },
  "straightEdge": false,
  "targetId": {
vertexX": "360",
   "valuevertexY": "360"

 }
}


Anchor
Modify a Task in a Workflow Properties
Modify a Task in a Workflow Properties

Modify a Task in a Workflow: Properties

Property

UI Field Name

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.

...

Modify a Task in a Workflow: URI Parameters

...

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

...

Modify a Task in a Workflow: Example Request

...

XML

...

JSON

Expand
titleXML
<workflowVertex>
      <alias>S30</alias>
      <task>Sleep 30</task>
      <vertexX>360</vertexX>
      <vertexY>60</vertexY>
</workflowVertex>
Expand
titleJSON
{
  "alias": "S30",
  "task": {
    "value": "sleep 30"
  },
  "vertexX": "360",
  "vertexY": "60"
}

...

Modify a Task in a Workflow: Properties

aliasAlias used for the task to be modified in the workflow; specifically, the value of ops_task_workflow_vertex.name.

Property

UI Field Name

Description

Specifications

Required

Anchor
alias - MTWalias - MTW

n/a

Specifications

Required

Anchor
alias - MTW
alias - MTW
alias

n/a

Alias used for the task to be modified in the workflow; specifically, the value of ops_task_workflow_vertex.name.


N

Anchor
conditionExpression - MTW
conditionExpression - MTW
conditionExpression		n/aBoolean 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 - MTW
task - MTW
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 task, the task must be unique in the workflow.
 
If both task and vertextId are specified, vertextId is used to search for the task to be modified.

Y
(unless vertextid
is specified.)

Anchor
vertexId - MTW
vertexId - MTW
vertexId

n/a

Vertex ID of the task within the workflow.
 
Each task within a Workflow has a unique Vertex ID to distinguish it from other tasks of the same name, if any.

Cannot be modified; used only to search for the task.
 
If both task and vertextId are specified, vertextId is used to search for the task to be modified.

Y
(unless task
is specified.)

Anchor
vertexX - MTW
vertexX - MTW
vertexX

n/a

x-coordinate of the task to be modified in the workflow.

Default is 0.

N

Anchor
vertexY - MTW
vertexY - MTW
vertexY

n/a

y-coordinate of the task to be modified in the workflow.

Default is 0.

N

...

XML

JSON


Expand
titleXML
<workflowVertices>
	  <workflowVertex>
		    <alias>Task 1</alias>
		 1</alias>
    <conditionExpression />
    <task sysId="1010f538c0a801c900e0fe0af94d9be5">task1</task>
    		<vertexId>5</vertexId>
		    <vertexX>253</vertexX>
		    <vertexY>296</vertexY>
	  </workflowVertex>
</workflowVertices>



Expand
titleJSON
[ 
  {
    "alias": "task 1",
    "conditionExpression": null,
    "task": {
      "sysId": "1010f538c0a801c900e0fe0af94d9be5",
      "value": "task1"
    },
    "vertexId": "5",
    "vertexX": "253",
    "vertexY": "296"
  } 
]



Note
titleNote

If there are no matching tasks to remove, an empty list is returned.

...

Property

UI Field Name

Description

Anchor
alias - DTW
alias - DTW
alias

n/a

Alias of the task removed from the Workflow; specifically, the value of ops_task_workflow_vertex.name.

Anchor
conditionExpression - DTW
conditionExpression - DTW
conditionExpression		n/aBoolean condition expression to specify the dependency criteria.

Anchor
task - DTW
task - DTW
task

Task Name

Name of the task removed from the Workflow.

Anchor
vertexId - DTW
vertexId - DTW
vertexId

n/a

Vertex ID of the task removed from the Workflow.
 
Each task within a Workflow has a unique Vertex ID to distinguish it from other tasks of the same name, if any.

Anchor
vertexX - DTW
vertexX - DTW
vertexX

n/a

x-coordinate of the task removed from the Workflow.

Anchor
vertexY - DTW
vertexY - DTW
vertexY

n/a

y-coordinate of the task removed from the Workflow.

...