Page Comparison

...

Universal Controller supports the following RESTful-based web services for Workflow Task Instance operations, which are listed alphabetically on this page.

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

...

	Description
URI	http://host_name/uc/resources/taskinstance/ops-task-insert
HTTP Method	POST
Description	Insert a task into a Workflow with dependencies.
Authentication	HTTP Basic
Example URI	http://localhost:8080/uc/resources/taskinstance/ops-task-insert
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Request Example	See Insert a Task into a Workflow with Dependencies: XML and JSON Examples.
Request Properties	See Insert a Task into a Workflow with Dependencies: Request Properties.
Response Example	See Insert a Task into a Workflow with Dependencies: XML and JSON Examples.

Anchor

	Insert a Task into a Workflow with Dependencies XML and JSON Examples
	Insert a Task into a Workflow with Dependencies XML and JSON Examples

...

Examples

XML

JSON

Example Request

Expand

title	XML

<task-insert>
    <name>Sleep 30</name>
    <alias>Test</alias>
    <workflowInstanceId>ac2cfdd14c8c4238a4a6ecd03db41e87</workflowInstanceId>
    <predecessors> 
        <predecessor>Sleep 30</predecessor>
    </predecessors>
    <successors> 
        <successor>Sleep 60</successor>
    </successors>
    < - ITvertexX>25</63544710vertexX>
    <inheritTriggerTime>true</inheritTriggerTime>
    <vertexY>25</vertexY>
</task-insert>

Expand

title	JSON

{
"name": "Sleep 10",
"alias": "Test",
"workflowInstanceId": "1513717759915306953T5FNZB71S6OUF",
"predecessors": [ "Task 1" ],
"successors": [ "Sleep 60" ],
"63544710vertexX": "25",
"inheritTriggerTime": "true",
"vertexY": "25"
}

Example Response

Expand

title	XML

<command-response>
    <type>create_task</type>
    <success>true</success>
    <info>Command Insert Task executed successfully against task instance "test workflow".</info>
    <errors />
</command-response>

Expand

title	JSON

{
  "type": "create_task",
  "success": true,
  "info": "Command Insert Task executed successfully against task instance \"Test Workflow\".",
  "errors": ""
}

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	alias - IT
	alias - IT

alias

n/a

Alias used for the task within the Workflow; specifically, the value of ops_exec_workflow_vertex.name.

N

Anchor

	id - IT
	id - IT

id

n/a

sys_id of the task to be inserted.

Y
(unless name
is specified)

name

Anchor

	name - IT
	name - IT

name

Task Name

Name of the task to be inserted.

Y
(unless id
is specified)

id

Anchor

	predecessors - IT
	predecessors - IT

predecessors

Predecessors

Comma-separated list of predecessor task instances within the workflow for the task to be inserted.

N

Anchor

	successors - IT
	successors - IT

successors

Successors

Comma-separated list of successor task instances within the workflow for the task to be inserted.

N

Anchor

	vertexX - IT
	vertexX - IT

vertexX

n/a

x-coordinate of the task to be inserted within the workflow.

Default is 0.

N

Anchor

	vertexY- IT
	vertexY- IT

vertexY

n/a

y-coordinate of the task to be inserted within the workflow.

Default is 0.

N

Anchor

	inheritTriggerTime - IT
	inheritTriggerTime - IT

inheritTriggerTime

n/a

Specification for whether or not the inserted task will inherit the Trigger Time of the Workflow task instance.

Boolean; Valid values (not case-sensitive):

Yes,Y,true
No, N, false

Default is Yes, Y, true.

N

Anchor

	workflowInstanceCriteria- IT
	workflowInstanceCriteria- IT

workflowInstanceCriteria

n/a

If search is by workflowInstanceName; Specific Workflow task instance with this task instance name which you want to insert the task into.

Valid values:

As String = oldest active instance, As Value = 1
As String = newest active instance, As Value = 2
As String = oldest instance, As Value = 3
As String = newest instance, As Value = 4

Default is oldest active instance (1).

Note

title	Note

Values with an underscore characters ( _ )
instead of spaces also are supported
(for example, oldest_active_instance).

N

Anchor

	workflowInstanceId - IT
	workflowInstanceId - IT

workflowInstanceId

n/a

sys_id of the Workflow to insert the task into.

Y
(unless workflowInstanceName
is specified)

workflowInstanceName

Anchor

	workflowInstanceName - IT
	workflowInstanceName - IT

workflowInstanceName

Instance Name

Name of the Workflow to insert the task into.

Y
(unless workflowInstanceId
is specified)

workflowInstanceId

...

	Description
URI	http://host_name/uc/resources/taskinstance/dependency/list
HTTP Method	GET
Description	Returns the list of task instance dependencies.
URI Parameters	See List Predecessors / Successors of a Task Instance in a Workflow: URI Parameters.
Example URI	To list all dependencies for the task instance id: http://localhost:8080/uc/resources/taskinstance/dependency/list?taskinstanceid=431191ad05e6483c8cfa71380947268c To list all successors for the task instance name X: http://localhost:8080/uc/resources/taskinstance/dependency/list?taskinstancename=X&dependencytype=successors To list all predecessors for the oldest task instance named X in workflow Y: http://localhost:8080/uc/resources/taskinstance/dependency/list?taskinstancename=X&workflowinstancename=Y&criteria=oldest_instance&dependencytype=predecessors
Authentication	HTTP Basic
Produces Content-Type	application/xml, application/json
Example Response	See List Predecessors / Successors of a Task Instance in a Workflow: XML and JSON Examples.
Response Properties	See List Predecessors / Successors of a Task Instance in a Workflow: Response Properties.

Anchor

	List Predecessors / Successors of a Task Instance in a Workflow XML and JSON Examples
	List Predecessors / Successors of a Task Instance in a Workflow XML and JSON Examples

...

XML

JSON

Expand

title	XML

<task-dependencies>
       <task-dependency>
              <condition>Success</condition>
              <name>Sleep 30</name>
              <satisfied>false</satisfied>
              <taskInstanceId>1471465078487058257PY97G57T09HKB</taskInstanceId>
              <type>predecessors</type>
              <vertexId>20</vertexId>
              <vertexName>Sleep 30</vertexName>
       </task-dependency>
       <task-dependency>
              <condition>Success</condition>
              <name>uc - Sleep 60</name>
              <satisfied>false</satisfied>
              <taskInstanceId>151371775991531795355TV2GX49AWD6</taskInstanceId>
              <type>successors</type>
              <vertexId>2</vertexId>
              <vertexName>Sleep 60</vertexName>
       </task-dependency>

Expand

title	JSON

[ {
  "condition": {
    "value": "Success"
  },
  "name": "Sleep 30",
  "satisfied": false,
  "taskInstanceId": "1471465078487058257PY97G57T09HKB",
  "type": "Predecessor",
  "vertexId": "20",
  "vertexName": "Sleep 30"
}, {
  "condition": {
    "value": "Success"
  },
  "name": "Sleep 60",
  "satisfied": false,
  "taskInstanceId": "151371775991531795355TV2GX49AWD6",
  "type": "Successor",
  "vertexId": "2",
  "vertexName": "Sleep 60"
} ]

Anchor

	List Predecessors / Successors of a Task Instance in a Workflow URI Parameters
	List Predecessors / Successors of a Task Instance in a Workflow URI Parameters

...

Versions Compared

Old Version 7

New Version Current

Key