Task Instance Web Services

Overview

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

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

For RESTful-based web services for Workflow Task Instance operations, see Workflow Task Instance Web Services.

Cancel a Task Instance

Note

A Web Service Task instance cannot be cancelled if the specified Protocol is SOAP.


Description

URI

HTTP Method

POST

Description

Cancel a task instance.

Example URI

http://localhost:8080/uc/resources/taskinstance/cancel

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Cancel a Task Instance: XML and JSON Examples.

Request Properties

See Cancel a Task Instance: Request Properties.

Example Response

See Cancel a Task Instance: XML and JSON Examples.

Cancel a Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
</task-instance>

or
<task-instance>
      <name>Timer 60</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName>
</task-instance>
 JSON
{
"name": "Timer 60",
"criteria": "Newest Instance",
"workflowInstanceName": "test"
}

Example Response

 XML
<command-response>
      <type>cancel</type>
      <success>true</success>
      <info>Command Cancel executed successfully against task instance "test".</info>
      <errors />
</command-response>
 JSON
{
  "type": "cancel",
  "success": true,
  "info": "Command Cancel executed successfully against task instance \"Timer 60\".",
  "errors": ""
}

Cancel a Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name that you want to cancel.

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

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

N


id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


Clear All Dependencies


Description

URI

http://host_name/uc/resources/taskinstance/cleardependencies

HTTP Method

POST

Description

Clears all dependencies of a task instance.

Example URI

http://localhost:8080/uc/resources/taskinstance/cleardependencies

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear All Dependencies: XML and JSON Examples.

Request Properties

See Clear All Dependencies: Request Properties.

Example Response

See Clear All Dependencies: XML and JSON Examples.

Clear All Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
	<id>1464817327170011848D633V6106ENQ7</id>
</task-instance>

or
<task-instance>
      <name>Timer 60</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
</task-instance>

 JSON
{
"name": "Timer 60",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

 XML
<command-response>
      <type>clear_all_dependencies</type>
      <success>true</success>
      <info>Command Clear All Dependencies executed successfully against task instance "Timer 60".</info>
      <errors />
</command-response>
 JSON
{
  "type": "clear_all_dependencies",
  "success": true,
  "info": "Command Clear All Dependencies executed successfully against task instance \"Timer 60\".",
  "errors": ""
}

Clear All Dependencies: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name for which
you want to clear all dependencies.

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

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

N


id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


Clear Exclusive Dependencies


Description

URI

http://host_name/uc/resources/taskinstance/clearexclusive

HTTP Method

POST

Description

Clears all exclusive dependencies of a task instance.

Authentication

HTTP Basic

Example URI

http://localhost:8080/uc/resources/taskinstance/clearexclusive

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Exclusive Dependencies: XML and JSON Examples.

Request Properties

See Clear Exclusive Dependencies: Request Properties.

Example Response

See Clear Exclusive Dependencies: XML and JSON Examples.

Clear Exclusive Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
	<id>1464817327170011848D633V6106ENQ7</id>
</task-instance>


or

<task-instance>
      <name>Timer 60</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
</task-instance>
 JSON
{
"name": "Timer 60",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

 XML
<command-response>
      <type>clear_exclusive</type>
      <success>true</success>
      <info>Command Clear Exclusive executed successfully against task instance "Timer 60".</info>
      <errors />
</command-response> 
 JSON
{
  "type": "clear_exclusive",
  "success": true,
  "info": "Command Clear Exclusive executed successfully against task instance \"Timer 60\".",
  "errors": ""
}

Clear Exclusive Dependencies: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name for which you want to clear exclusive dependencies.

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

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

N


id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


Clear Predecessor Dependencies


Description

URI

http://host_name/uc/resources/taskinstance/clearpredecessors

HTTP Method

POST

Description

Clears all predecessor dependencies of a task instance in a Workflow.

Authentication

HTTP Basic

Example URI

http://localhost:8080/uc/resources/taskinstance/clearpredecessors

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Predecessor Dependencies: XML and JSON Examples.

Request Properties

See Clear Predecessor Dependencies: Request Properties.

Example Response

See Clear Predecessor Dependencies: XML and JSON Examples.

Clear Predecessor Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <predecessorName>*</predecessorName>
</task-instance>


or

<task-instance>
      <name>Timer 60</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
      <predecessorName>*</predecessorName>
</task-instance>
 JSON
{
"name": "Timer 60",
"criteria": "Newest Instance",
"workflowInstanceName": "Test",
"predecessorName": "Task 1"
}

Example Response

 XML
<command-response>
      <type>set_edges_satisfied</type>
      <success>true</success>
      <info>Command Clear Predecessors executed successfully against task instance "Timer 60".</info>
      <errors />
</command-response>
 JSON
{
  "type": "set_edge_satisfied",
  "success": true,
  "info": "Successfully marked the dependency as satisfied.",
  "errors": ""
}

Clear Predecessor Dependencies: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name for which you want to clear predecessor dependencies.

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

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

N


id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

predecessorName

n/a

Name of the predecessor task instance for which you want to clear dependency.

* = Clears dependencies from all predecessor task instances.

Y


workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


Clear Time Dependency


Description

URI

http://host_name/uc/resources/taskinstance/cleartimewait

HTTP Method

POST

Description

Clears the time dependency of a task instance.

Authentication

HTTP Basic

Example URI

http://localhost:8080/uc/resources/taskinstance/cleartimewait

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Time Dependency: XML and JSON Examples.

Request Properties

See Clear Time Dependency : Request Properties.

Example Response

See Clear Time Dependency: XML and JSON Examples.

Clear Time Dependency: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
</task-instance>


or

<task-instance>
      <name>Test task</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
</task-instance>
 JSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

 XML
<command-response>
      <type>clear_timewait</type>
      <success>true</success>
      <info>Command Clear Time Wait/Delay executed successfully against task instance "Test task".</info>
      <errors />
</command-response> 
 JSON
{
  "type": "clear_timewait",
  "success": true,
  "info": "Command Clear Time Wait/Delay executed successfully against task instance \"Task 1\".",
  "errors": ""
}

Clear Time Dependency: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name for which you want to clear time dependency.

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

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

N


id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


Clear Virtual Resource Dependencies


Description

URI

http://host_name/uc/resources/taskinstance/clearresources

HTTP Method

POST

Description

Clears virtual resource dependencies of a task instance.

Authentication

HTTP Basic

Example URI http://localhost:8080/uc/resources/taskinstance/clearresources

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Virtual Resource Dependencies: XML and JSON Examples.

Request Properties

See Clear Virtual Resource Dependencies: Request Properties.

Example Response

See Clear Virtual Resource Dependencies: XML and JSON Examples.

Clear Virtual Resource Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <resourceName>V1</resourceName>
</task-instance>


or

<task-instance>
      <name>Timer 60</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
      <resourceName>V1</resourceName>
</task-instance>
 JSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test",
"resourceName": "V1"
}

Example Response

 XML
<command-response>
      <type>clear_resources</type>
      <success>true</success>
      <info>Command Clear Resources executed successfully against task instance "Timer 60".</info>
      <errors />
</command-response>
 JSON
{
  "type": "clear_resources",
  "success": true,
  "info": "Command Clear Resources executed successfully against task instance \"Task 1\".",
  "errors": ""
}

Clear Virtual Resource Dependencies: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name for which you want to clear virtual resource dependencies.

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

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

N


id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

resourceName

n/a

Name of the virtual resource for which you want to clear dependency.

* = Clears dependencies from all virtual resources.

Y


workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


Delete a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance

HTTP Method

DELETE

Description

Deletes the specified task instance. For Workflow task instances, if the recursive property is set to true, all children task instances will be removed.

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Example URI

http://localhost:8080/uc/resources/taskinstance

Example Request

See Delete a Task Instance: XML and JSON Examples.

Request Properties

See Delete a Task Instance: Request Properties.

Example Response

  • Status 200 /OK
    Task instance(s) deleted successfully.

Delete a Task Instance: XML and JSON Examples

XML

JSON

 XML

Delete Task instance by task instance id.


<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
</task-instance>


 
 
Delete Task instance and all of its children by task instance id.


<task-instance>
      <id>14483224900880190549PGHP23IR12MO</id>
      <recursive>true</recursive>
</task-instance>


 
 
Delete Task instance by task instance name.


<task-instance>
      <name>Timer 60</name>
      <criteria>Newest Instance</criteria>
</task-instance>
 JSON
{
"name": "Task 1",
"criteria": "Newest Instance"
}

Delete a Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name which you want to delete.

Valid values:


  • As String = Oldest Instance, As Value = 3
  • As String = Newest Instance, As Value = 4

Default is Oldest Instance (3).
 


Note

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

N


id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

recursive

n/a

For Workflow task instances only; Specification for whether or not to delete all children task instances of the task instance.

Boolean; Valid values: true/false. Default is false.

N


Force Finish a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/forcefinish

HTTP Method

POST

Description

Force Finish a task instance. (To Force Finish (Halt) a task instance, set the halt property to true.)

Example URI

http://localhost:8080/uc/resources/taskinstance/forcefinish

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Force Finish a Task Instance: XML and JSON Examples.

Request Properties

See Force Finish a Task Instance: Request Properties.

Example Response

See Force Finish a Task Instance: XML and JSON Examples.

Force Finish a Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
</task-instance>


or

<task-instance>
      <name>Timer 60</name>
      <halt>true</halt>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
</task-instance>
 JSON
{
"name": "Task 1",
"halt": "True",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

 XML
<command-response>
    <type>force_finish</type>
    <success>true</success>
    <info>Command Force Finish executed successfully against task instance "test".</info>
    <errors />
</command-response>
 JSON
{
  "type": "force_finish",
  "success": true,
  "info": "Command Force Finish executed successfully against task instance \"Task 1\".",
  "errors": ""
}

Force Finish a Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name that you want to force finish.

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

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

N


halt

n/a

Prevents successor task instances of the specified task instance in a Workflow from being run.

Boolean. Valid values: true/false. Default is false.

N


id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details.

N


Force Finish/Cancel a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/forcefinishcancel

HTTP Method

POST

Description

Force Finish/Cancel a task instance. (To Force Finish/Cancel (Halt) a task instance, set the halt property to true.)

Example URI

http://localhost:8080/uc/resources/taskinstance/forcefinishcancel

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Force Finish Cancel a Task Instance: XML and JSON Examples.

Request Properties

See Force Finish/Cancel a Task Instance: Request Properties.

Example Response

See Force Finish Cancel a Task Instance: XML and JSON Examples.

Force Finish/Cancel a Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
</task-instance>


or

<task-instance>
      <name>Timer 60</name>
      <halt>true</halt>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
</task-instance>
 JSON
{
"name": "Task 1",
"halt": "True",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

 XML
<command-response>
    <type>force_finish_cancel</type>
    <success>true</success>
    <info>Command Force Finish/Cancel executed successfully against task instance "test".</info>
    <errors />
</command-response>
 JSON
{
  "type": "force_finish_cancel",
  "success": true,
  "info": "Command Force Finish/Cancel executed successfully against task instance \"Task 1\".",
  "errors": ""
}

Force Finish/Cancel a Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name that you want to force finish/cancel.

Valid values: