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.

Task Instance Status Types

The following table describes all possible task instance statuses for all task types.

Note

The format of multi-word task status names specified in the Task Instance Status Web Service differs from the format of task status names used in the Controller user interface. In Task Instance Status, the words are separated by an underscore character; in the user interface, they are separated by a space.

Status Name

Status Code

Task Type

Description

Action_Required

60

Manual

When a manual task launches, it goes into Action Required status, meaning a user must perform some manual activity. For details, see Manual task.

Cancel_Pending

99

Agent-based

A process running on the Agent needs to be terminated. When the Cancel command is issued, the task instance will go into a Cancel Pending status until the Agent reports back that the process has been cancelled. At that point, the task instance will transition into the Cancelled status.

Cancelled

130

All

The task was cancelled by a user.

Confirmation_Required

125

z/OS

If you make JCL changes and restart a z/OS task, Universal Controller will put the task into Confirmation Required status and prompt you for a confirmation. For detailed processing steps, see Rerunning a z/OS Task.

Defined

0

All

The new task instance has been created (the task has been launched).

Exclusive_Requested

22

All

All tasks with a mutually exclusive task defined go immediately to a status of Exclusive Requested. If the task is available to run exclusively, the task then moves to the next appropriate processing status.

Exclusive_Wait

23

All

The task is mutually exclusive with one or more other tasks, and it is waiting for those tasks to finish before it will run.

Execution_Wait

33

Agent-based

The task must wait to be completed; either the Agent/Agent Cluster running the task has reached its Task Execution Limit, or the ability of the Agent/Agent Cluster to run tasks has been suspended.

Failed

140

All*

The task ran to a failure status.

Finished

190

All

The task was forced by the user to finish. The user may do this in cases where the task had a Cancelled or Failed status, and the user needed to release other task instances depending on the successful completion of this task instance in a workflow. For more information, see Force Finishing a Task.

Held

20

All

The task has been put on hold by a user.

In_Doubt

110

Agent-based

The Agent is "in doubt" about the current status of the task instance. This may occur if an Agent or Agent connection goes down. In this case, the Agent restarts and reviews its data about tasks in progress. If the Agent finds a task still running, it resumes normal monitoring. If the Agent cannot find the task, this usually indicates that the task completed, but the Agent considers the task status to be "in doubt."

Queued

40

Agent-based

The task has been queued on a resource.

Resource_Requested

25

All

All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is available, the task then moves to the next appropriate processing status.

Resource_Wait

30

All

All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is not available, the task goes to a status of Resource Wait. When the resource becomes available, the task moves to the next appropriate processing status

Running

80

All

The task is running. For Agent-based tasks, the Agent has started running the program.

Running/Problems

81

Workflow

One or more tasks within the workflow has one of the following statuses:

  • Cancelled
  • Confirmation Required
  • Failure
  • In Doubt
  • Running/Problems (for sub-workflows)
  • Start Failure
  • Undeliverable

Skipped

180

All

The task was skipped by a user.

Start Failure

120

All

The task was unable to start.

Started

70

Agent-based, Manual

The task has started. For Agent-based tasks, this means the Agent has received the task.

Submitted

43

z/OS

The task has been submitted to the z/OS Job Entry subsystem and scheduled by the z/OS Job Scheduler.

Success

200

All

The task has completed successfully. Workflows will transition to Success status when all of its tasks have transitioned to Success, Finished, or Skipped status.

Time_Wait

15

All (except Timer)

The task is waiting to start based on a Wait To Start and/or Delay On Start specification.

Undeliverable

35

Agent-based

The Agent is unavailable.

Waiting

10

All

The task has been loaded by a workflow and is waiting on a predecessor.

* Workflows cannot go to Failed status.

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


  • 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


Hold a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/hold

HTTP Method

POST

Description

Hold a task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Hold a Task Instance: XML and JSON Examples.

Request Properties

See Hold a Task Instance: Request Properties.

Example Response

See Hold a Task Instance: XML and JSON Examples.

Hold a Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
      <id>410d6c0bc0a801c901838d8ac43b3279</id>
</task-instance>


or

<task-instance>
      <name>Timer 60</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>hold</type>
    <success>true</success>
    <info>Command Hold executed successfully against task instance "test".</info>
    <errors />
</command-response>
 JSON
{
  "type": "hold",
  "success": true,
  "info": "Command Hold executed successfully against task instance \"Task 1\".",
  "errors": ""
}

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

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


Issue Set Completed Command for a Manual Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/setcompleted

HTTP Method

POST

Description

Issues a Set Completed command for a Manual Task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples.

Request Properties

See Issue Set Completed Command for a Manual Task Instance: Request Properties.

Example Response

See Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples.

Issue Set Completed Command for a Manual Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request

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


or

<task-instance>
      <name>test manual</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>set_manual_completed</type>
    <success>true</success>
    <info>Command Set Completed executed successfully against task instance "test".</info>
    <errors />
</command-response>
 JSON
{
  "type": "set_manual_completed",
  "success": true,
  "info": "Command Set Completed executed successfully against task instance \"Task 1\".",
  "errors": ""
}

Issue Set Completed Command for a Manual 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 issue a Set Completed command for.

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


Issue Set Started Command for a Manual Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/setstarted

HTTP Method

POST

Description

Issues a Set Started command for a Manual Task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Issue Set Started Command for a Manual Task Instance: XML and JSON Examples.

Request Properties

See Issue Set Started Command for a Manual Task Instance: Request Properties

Example Response

See Issue Set Started Command for a Manual Task Instance: XML and JSON Examples.

Issue Set Started Command for a Manual Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request

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


or

<task-instance>
      <name>test manual</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>set_manual_started</type>
    <success>true</success>
    <info>Command Set Started executed successfully against task instance "test".</info>
    <errors />
</command-response>
 JSON
{
  "type": "set_manual_started",
  "success": true,
  "info": "Command Set Started executed successfully against task instance \"Task 1\".",
  "errors": ""
}

Issue Set Started Command for a Manual 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 issue a Set Started command for.

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


List Task Instances


Description

URI

http://host_name/uc/resources/taskinstance/list

HTTP Method

POST

Description

Retrieves information on task instances matching specific search criteria.

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See List Task Instances: XML and JSON Request Examples.

Request Properties

See List Task Instances: Request Properties.

Example Response

See List Task Instances: XML and JSON Response Examples.

List Task Instances: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML

Task instance with multiple query criteria.


<task-instance-query-filter>
      <name>B-06884*</name>
      <status>!45</status>
      <customField1>My*</customField1>
      <customField2>*Custom*</customField2>
      <workflowDefinitionId>36551ed5663042c2b79975ad6a23915e</workflowDefinitionId>
      <taskName>B-06884 - Timer - END - ${B_08477_WKFLW_ID}</taskName>
</task-instance-query-filter> 


 
 
All task instances in the last three minutes.


<task-instance-query-filter>
      <name>*</name>
      <updatedTimeType>Offset</updatedTimeType>
      <updatedTime>-3mn</updatedTime>
</task-instance-query-filter> 


 
 
Task instance with the specified id.


<task-instance-query-filter>
      <sysId>1448396297341015141TB2QF51JBYM8V</sysId>
</task-instance-query-filter> 


 
 
Task instance with multiple query criteria.


<task-instance-query-filter>
      <name>*</name>
      <status>110</status>
      <type>windows</type>
      <agentName>test agent</agentName>
      <lateStart>true</lateStart>
      <lateFinish>true</lateFinish>
      <earlyFinish>false</earlyFinish>
</task-instance-query-filter> 


 
All task instances that either started late or finished late.


<task-instance-query-filter>
      <name>*</name>
      <late>true</late>
</task-instance-query-filter>


 
All task instances that either started late, finished late, or finished early.


<task-instance-query-filter>
      <name>*</name>
      <lateEarly>true</lateEarly>
</task-instance-query-filter>


 
All task instances that neither started late nor finished late.


<task-instance-query-filter>
      <name>*</name>
      <late>false</late>
</task-instance-query-filter>


 
All task instances that neither started late, finished late, nor finished early.


<task-instance-query-filter>
      <name>*</name>
      <lateEarly>false</lateEarly>
</task-instance-query-filter>



Task instance with the specified template name.

  
<task-instance-query-filter>
        <name>*</name>
        <templateName>Demo_Ext_1</templateName>
  </task-instance-query-filter> 


Task instance with updated time type: between.

<task-instance-query-filter>
       <name>*</name>
       <updatedTimeType>between</updatedTimeType>
       <updatedTime>2022-08-08 10:56:00 -0400,2022-08-10 10:56:00 -0400</updatedTime>
</task-instance-query-filter>

 
 JSON

Task instance with multiple query criteria.


{
      "name": "*",
      "status": "!45",
      "instanceNumber": 2,
      "businessServices": "Rgr A",
      "customField2": "*Custom*"
}


 
All task instances in the last three minutes.


{
      "name": "*",
      "type": "Timer",
      "updatedTimeType": "offset",
      "updatedTime": "-3mn"
 }    


 
Task instance with the specified id.


{
      "sysId": "1513644026115413351LS9ACLESSKLXZ"
       
 }    


 
Task instance with multiple query criteria.


{
      "name": "*",
      "status": "200",
      "type": "windows",
      "agentName": "Mark-4 - AGNT0002",
      "lateStart": true,
      "lateFinish": false,
      "earlyFinish": false
 }    


 
All task instances that either started late or finished late.


{
      "name": "*",
      "late": true
 }    


 
All task instances that either started late, finished late, or finished early.


{
      "name": "*",
      "lateEarly": true
 }    


 
All task instances that neither started late nor finished late.


 {
      "name": "*",
      "late": false
 }    


 
All task instances that neither started late, finished late, nor finished early.


{
      "name": "*",
      "lateEarly": false
 }    



Task instance with the specified template name.

  
{
        "name": "*"
        "templateName": Demo_Ext_1
 }


Task instance with updated time type: between.

{

"name": "*",

"type": "Timer",

"updatedTimeType": "between",

"updatedTime": "2022-08-08 10:56:00 -0400,2022-08-10 10:56:00 -0400"

}



Example Response

 XML
<taskInstance>
  <agent />
  <credentials />
  <customField1 label="Custom 1">My Custom Field #1</customField1>
  <customField2 label="Custom 2">My Other Custom Field #2</customField2>
  <earlyFinish>false</earlyFinish>
  <endTime></endTime>
  <executionUser>ops.admin</executionUser>
  <exitCode>0</exitCode>
  <finishedEarly>false</finishedEarly>
  <finishedLate>false</finishedLate>
  <instanceNumber>6</instanceNumber>
  <lateFinish>false</lateFinish>
  <lateStart>false</lateStart>
  <launchTime>2019-06-27 11:18:41 -0400</launchTime>
  <name>B-06884 - Timer - END - 15616456627821537077YBESF7H0KELV</name>
<progress>100</progress> <queuedTime></queuedTime> <startTime>2019-06-27 11:18:41 -0400</startTime> <startedLate>false</startedLate> <status>RUNNING</status> <statusDescription /> <sysId>15616456627821537077YBESF7H0KELV</sysId> <taskId>05564cd1f6c4484997cfb66782feb0d0</taskId> <taskName>B-06884 - Timer - END - ${B_08477_WKFLW_ID}</taskName> <templateId /> <templateName /> <triggerId /> <triggerName /> <triggerTime>2019-06-27 11:18:41 -0400</triggerTime> <triggeredBy>Workflow: B-06884 - Main ${ops_task_ref_count}</triggeredBy> <type>Timer</type> <updatedTime>2019-06-27 11:18:41 -0400</updatedTime> <workflowDefinitionId>36551ed5663042c2b79975ad6a23915e</workflowDefinitionId> <workflowDefinitionName>B-06884 - Main ${ops_task_ref_count}</workflowDefinitionName> <workflowInstanceId>15616456627821077078N9HWVH7SLHVT</workflowInstanceId> <workflowInstanceName>B-06884 - Main 3</workflowInstanceName> <businessServices> <businessService>Accounting</businessService> <businessService>QA Department</businessService> </businessServices> </taskInstance> </taskInstance>
 JSON
{
  "agent": null,
  "businessServices": [
    "Accounting",
    "QA Department"
  ],
  "credentials": null,
  "customField1": {
     "label": "Custom 1",
     "value": "My Custom Field #1"
  },
  "customField2": {
     "label": "Custom 2",
     "value": "My Other Custom Field #2"
  },
  "earlyFinish": "false",
  "endTime": "2019-06-27 11:20:11 -0400",
  "executionUser": "ops.admin",
  "exitCode": "0",
  "finishedEarly": "false",
  "finishedLate": "false",
  "instanceNumber": 6,
  "lateFinish": "false",
  "lateStart": "false",
  "launchTime": "2019-06-27 11:18:41 -0400",
  "name": "B-06884 - Timer - END - 15616456627821537077YBESF7H0KELV",
"progress": "100", "queuedTime": "", "startTime": "2019-06-27 11:18:41 -0400", "startedLate": "false", "status": "SUCCESS", "statusDescription": null, "sysId": "15616456627821537077YBESF7H0KELV", "taskId": "05564cd1f6c4484997cfb66782feb0d0", "taskName": "B-06884 - Timer - END - ${B_08477_WKFLW_ID}", "templateId": null, "templateName": null, "triggerId": null, "triggerName": null, "triggerTime": "2019-06-27 11:18:41 -0400", "triggeredBy": "Workflow: B-06884 - Main ${ops_task_ref_count}", "type": "Timer", "updatedTime": "2019-06-27 11:20:11 -0400", "workflowDefinitionId": "36551ed5663042c2b79975ad6a23915e", "workflowDefinitionName": "B-06884 - Main ${ops_task_ref_count}", "workflowInstanceId": "15616456627821077078N9HWVH7SLHVT", "workflowInstanceName": "B-06884 - Main 3" }

List Task Instances: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

agentName

Agent

Name of the agent that this task instances is assigned to run on.


N


businessServices

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N


customField1

Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.)

User-defined task field 1.

Wildcards are supported.

N


customField2

Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.)

User-defined task field 2.

Wildcards are supported.

N


executionUser

Execution User

Execution User of a task instance that determines the security context under which the task instance runs.

System-supplied.

N


instanceNumber

Instance Number

Sequentially assigned number, maintained per task, representing the creation order of the instance.

Integer value.

N


late

Started Late / Finished Late

Indication of whether or not to list all task instances that started late or finished late.

Valid values: true/false.

N


lateEarly

Started Late / Finished Late / Finished Early

Indication of whether or not to list all task instances that started late, finished late, or finished early.

Valid values: true/false.

N


name

Instance name

Name or partial name of one or more task instances.

Wildcards are supported.

Y
(unless sysId
is specified)

sysId

status

Status

List of comma-separated task instance status codes and/or names (not case sensitive).

Specifying one or more statuses automatically excludes task instances in all other statuses.
 
To list task instances for all statuses, enter <status></status> in the request.
 
To list task instances for all statuses except one or more specific statuses, enter the status code or name for each status to be excluded with a preceding exclamation mark ( ! ). For example, !200.

N


statusDescription

Status Description

Description (if any) of the current status of the Task Instance.

Wildcards are supported.

N


sysId

n/a

sys_id used within the Controller to identify a task instance.


Y
(unless name
is specified)

name

taskId

n/a

sys_id of the task definition that this Task Instance was created from.


N

taskName

taskName

n/a

Name of the task definition that this Task Instance was created from.


N

taskId

templateId

n/a ID used within the controller to identify a template. If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. N templateName

templateName

Template Name Name of a template. If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. N templateId

triggerId

n/a

sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger).


N

triggerName

triggerName

n/a

Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.)


N

triggerId

type

n/a

Task type of this task instance.

Valid values: One of the following (not case sensitive): application_control, email, email_monitor, agent_file_monitor, ftp, remote_file_monitor, indesca / universal_command / ucmd, manual, sap, sql, stored_procedure, system_monitor, task_monitor, timer, universal, unix, variable_monitor, web_service, windows, workflow, zos.
 
To list task instances for all task types, enter <type></type> in the request.

N


updatedTime

n/a

If updatedTimeType = Offset; -offset period.

Valid values:


  • mn (minutes)


  • h (hours)


  • d (days)


Default is d.
 
Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days).
 
If updatedTimeType is Since; date/time value
( yyyy-MM-dd [HH:mm:ss] )

If updatedTimeType is Between; date/time values (start date/time inclusive, end date/time exclusive)
( yyyy-MM-dd [HH:mm:ss],  yyyy-MM-dd [HH:mm:ss])
 


Note

The time is relative to the Time Zone specified for the User.

Y
(if updatedTimeType
is Offset, Since,
or Older Than.)


updatedTimeType

n/a

Type of updateTime.

Valid values:

  • As String = Today, As Value = 1
  • As String = Offset, As Value = 2
  • As String = Since, As Value = 3
  • As String = Older Than, As Value = 4
  • As String = Between, As Value = 5

N


workflowDefinitionId

n/a

sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).


N

workflowDefinitionName

workflowDefinitionName

n/a

Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).


N

workflowDefinitionId

workflowInstanceCriteria

n/a

Specification for how workflowInstanceName finds the matching workflow.

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


workflowInstanceId

n/a

sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed.


N

workflowInstanceName

workflowInstanceName

Workflow

Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed.


N

workflowInstanceId

List Task Instances: Advanced 


 Description

URI

http://host_name/uc/resources/taskinstance/listadv

http://host_name/uc/resources/taskinstance/listAdv

HTTP Method

POST

Description

List Task instance output details

Example URI

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

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

Authentication

HTTP Basic

Produces Content-Type


Consumes Content-Type

Application/XML & Application/JSON

Example Request

See List Task Instances - Advanced: XML and JSON Request Examples.

Example Response

See List Task Instances - Advanced: XML and JSON Response Examples.

Request Properties

See List Task Instances - Advanced: Request Properties.

List Task Instances - Advanced: XML and JSON Request Examples

Examples

XML

JSON

Example Request

 XML
<task-instance-query-filter>
      <name>*</name>
      <instanceOutputType>STDOUT</instanceOutputType>
      <responseFields>type,status</responseFields>
</task-instance-query-filter> 

<task-instance-query-filter>
      <name>*</name>
      <updatedTimeType>between</updatedTimeType>
      <updatedTime>2022-08-08 10:56:00 -0400,2022-08-10 10:56:00 -0400</updatedTime>
</task-instance-query-filter>

<task-instance-query-filter>
      <name>*</name>
      <instanceOutputType>STDOUT</instanceOutputType>
      <responseFields>*</responseFields>
</task-instance-query-filter> 



 JSON
{
      "name": "*",
      "instanceOutputType": "STDOUT",
      "responseFields": "type,status"
}

{
      "name": "*",
      "type": "Timer",
      "updatedTimeType": "between",
      "updatedTime": "2022-08-08 10:56:00 -0400,2022-08-10 10:56:00 -0400"
 } 

{ "name": "*", "instanceOutputType": "STDOUT", "responseFields": "*" }


Example Response

 XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<taskInstances>
    <taskInstance>
        <name>Demo_exit_1</name>
        <taskInstanceOutputs>
            <taskInstanceOutput>
                <attemptCount>1</attemptCount>
                <outputData>Extension1 instantiated!</outputData>
                <outputType>STDOUT</outputType>
            </taskInstanceOutput>
        </taskInstanceOutputs>
        <status>SUCCESS</status>
        <sysId>1656255075614055024S5Y1Y9WQJD87I</sysId>
        <type>Universal</type>
    </taskInstance>
    <taskInstance>
        <name>Demo_exit_1</name>
        <taskInstanceOutputs>
            <taskInstanceOutput>
                <attemptCount>1</attemptCount>
                <outputData>Extension1 instantiated!</outputData>
                <outputType>STDOUT</outputType>
            </taskInstanceOutput>
        </taskInstanceOutputs>
        <status>SUCCESS</status>
        <sysId>1656255075614085024ZDRECO2XNVXYF</sysId>
        <type>Universal</type>
    </taskInstance>
</taskInstances>
 JSON
[
    {
        "name": "Demo_exit_1",
        "output": [
            {
                "attemptCount": 1,
                "commandName": null,
                "outputData": "Extension1 instantiated!\n*******************************************************\nState variable types:\nf2: <class 'float'>\ncred1: <class 'dict'>\ncred1.token: <class 'str'>\ncred1.user: <class 'str'>\ncred1.keyLocation: <class 'str'>\nchoice_3: <class 'list'>\nprint_types: <class 'bool'>\ncred1.pasphrase: <class 'str'>\nscr1: <class 'str'>\narray1: <class 'list'>\ncred1.password: <class 'str'>\narray2: <class 'list'>\n*******************************************************\n*******************************************************\nState variables & Values:\nf2 = 123.45\ncred1 = {'token': '', 'user': 'B-09028_Pwd_40', 'keyLocation': '', 'pasphrase': '', 'password': 'o*I\\\\K7/lYxf[O\\\\@wD*wDsX^akVU=uZO+;G;lHfNz'}\ncred1.token = \ncred1.user = B-09028_Pwd_40\ncred1.keyLocation = \nchoice_3 = []\nprint_types = True\ncred1.pasphrase = \nscr1 = C:\\Program Files\\Universal\\tmp\\a05909b7-868b-495f-84a7-a3893952f2de.\narray1 = []\ncred1.password = ****\narray2 = []\n*******************************************************\n",
                "outputFileName": null,
                "outputType": "STDOUT"
            }
        ],
        "status": "SUCCESS",
        "sysId": "1656255075614055024S5Y1Y9WQJD87I",
        "type": "Universal"
    },
    {
        "name": "Demo_exit_1",
        "output": [
            {
                "attemptCount": 1,
                "commandName": null,
                "outputData": "Extension1 instantiated!\n*******************************************************\nState variable types:\nf2: <class 'float'>\ncred1: <class 'dict'>\ncred1.token: <class 'str'>\ncred1.user: <class 'str'>\ncred1.keyLocation: <class 'str'>\nchoice_3: <class 'list'>\nprint_types: <class 'bool'>\ncred1.pasphrase: <class 'str'>\nscr1: <class 'str'>\narray1: <class 'list'>\ncred1.password: <class 'str'>\narray2: <class 'list'>\n*******************************************************\n*******************************************************\nState variables & Values:\nf2 = 123.45\ncred1 = {'token': '', 'user': 'B-09028_Pwd_40', 'keyLocation': '', 'pasphrase': '', 'password': 'o*I\\\\K7/lYxf[O\\\\@wD*wDsX^akVU=uZO+;G;lHfNz'}\ncred1.token = \ncred1.user = B-09028_Pwd_40\ncred1.keyLocation = \nchoice_3 = []\nprint_types = True\ncred1.pasphrase = \nscr1 = C:\\Program Files\\Universal\\tmp\\79c7b74f-a413-46b1-a6ec-0a526804b3a1.\narray1 = []\ncred1.password = ****\narray2 = []\n*******************************************************\n",
                "outputFileName": null,
                "outputType": "STDOUT"
            }
        ],
        "status": "SUCCESS",
        "sysId": "1656255075614085024ZDRECO2XNVXYF",
        "type": "Universal"
    }
]

List Task Instances - Advanced: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

agentName

Agent

Name of the agent that this task instances is assigned to run on.


N


businessServices

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N


customField1

Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.)

User-defined task field 1.

Wildcards are supported.

N


customField2

Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.)

User-defined task field 2.

Wildcards are supported.

N


executionUser

Execution User

Execution User of a task instance that determines the security context under which the task instance runs.

System-supplied.

N


instanceNumber

Instance Number

Sequentially assigned number, maintained per task, representing the creation order of the instance.

Integer value.

N


instanceOutputType

Output Type

Type of task instance output to retrieve.

String; Valid values:

  • As String = STDOUT, As Value = 1

  • As String = STDERR, As Value = 2

  • As String = FILE, As Value = 3

  • As String = JOBLOG, As Value = 4

  • As String = SCRIPT, As Value = 5

  • As String = SAP JOBDEF, As Value = 6

  • As String = SAP JOBSTAT, As Value = 7

  • As String = SAP JOBLOG, As Value = 8

  • As String = SAP SPOOLLIST, As Value = 9

  • As String = SAP PURGE, As Value = 10

  • As String = SAP ABORT, As Value = 11

  • As String = SAP INTERRUPT, As Value = 12

  • As String = SAP CHAIN - PLAN, As Value = 13

  • As String = SAP CHAIN - INSTANCE, As Value = 14

  • As String = SAP CHAINSTAT, As Value = 15

  • As String = SAP CHAINLOG, As Value = 16

  • As String = SAP CHAIN RESTART, As Value = 17

  • As String = WEB SERVICE, As Value = 18

  • As String = EXTENSION, As Value = 19

  • As String = COMMAND, As Value = 20

  • As String = SQL, As Value = 21

  • As String = STOREDPROC, As Value = 22

  • Default is All

N


late

Started Late / Finished Late

Indication of whether or not to list all task instances that started late or finished late.

Valid values: true/false.

N


lateEarly

Started Late / Finished Late / Finished Early

Indication of whether or not to list all task instances that started late, finished late, or finished early.

Valid values: true/false.

N


name

Instance name

Name or partial name of one or more task instances.

Wildcards are supported.

Y
(unless sysId
is specified)

sysId

responseFields

N/A

Allowed Response fields

Comma separated list of any of the following fields can be viewed.

"*" returns all fields listed below.

If left empty, the default fields will be returned. 


  • sysId - Default

  • name - Default

  • type

  • status

  • triggerTime

  • launchTime

  • queuedTime

  • startTime

  • endTime

  • updatedTime

  • triggeredBy

  • lateStart

  • lateFinish

  • earlyFinish

  • startedLate

  • finishedLate

  • finishedEarly

  • exitCode

  • executionUser

  • agent

  • credentials

  • instanceNumber

  • taskId

  • taskName

  • sourceVersion

  • triggerId

  • triggerName

  • workflowDefinitionId

  • workflowDefinitionName

  • workflowInstanceId

  • workflowInstanceName

  • statusDescription

  • businessServices

  • customField1

  • customField2

  • progress

  • extensionStatus

N


status

Status

List of comma-separated task instance status codes and/or names (not case sensitive).

Specifying one or more statuses automatically excludes task instances in all other statuses.
 
To list task instances for all statuses, enter <status></status> in the request.
 
To list task instances for all statuses except one or more specific statuses, enter the status code or name for each status to be excluded with a preceding exclamation mark ( ! ). For example, !200.

N


statusDescription

Status Description

Description (if any) of the current status of the Task Instance.

Wildcards are supported.

N


sysId

n/a

sys_id used within the Controller to identify a task instance.


Y
(unless name
is specified)

name

taskId

n/a

sys_id of the task definition that this Task Instance was created from.


N

taskName

taskName

n/a

Name of the task definition that this Task Instance was created from.


N

taskId

templateId

n/a ID used within the controller to identify a template. If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. N templateName

templateName

Template Name Name of a template. If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. N templateId

triggerId

n/a

sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger).


N

triggerName

triggerName

n/a

Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.)


N

triggerId

type

n/a

Task type of this task instance.

Valid values: One of the following (not case sensitive): application_control, email, email_monitor, agent_file_monitor, ftp, remote_file_monitor, indesca / universal_command / ucmd, manual, sap, sql, stored_procedure, system_monitor, task_monitor, timer, universal, unix, variable_monitor, web_service, windows, workflow, zos.
 
To list task instances for all task types, enter <type></type> in the request.

N


updatedTime

n/a

If updatedTimeType = Offset; -offset period.

Valid values:

  • mn (minutes)
  • h (hours)
  • d (days)

Default is d.
 
Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days).
 
If updatedTimeType is Since; date/time value
( yyyy-MM-dd [HH:mm:ss] )
 

If updatedTimeType is Between; date/time values (start date/time inclusive, end date/time exclusive)
( yyyy-MM-dd [HH:mm:ss],  yyyy-MM-dd [HH:mm:ss])


Note

The time is relative to the Time Zone specified for the User.

Y
(if updatedTimeType
is Offset, Since,
or Older Than.)


updatedTimeType

n/a

Type of updateTime.

Valid values:

  • As String = Today, As Value = 1

  • As String = Offset, As Value = 2

  • As String = Since, As Value = 3

  • As String = Older Than, As Value = 4

  • As String = Between, As Value = 5

N


workflowDefinitionId

n/a

sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).


N

workflowDefinitionName

workflowDefinitionName

n/a

Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow).


N

workflowDefinitionId

workflowInstanceCriteria

n/a

Specification for how workflowInstanceName finds the matching workflow.

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


workflowInstanceId

n/a

sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed.


N

workflowInstanceName

workflowInstanceName

Workflow

Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed.


N

workflowInstanceId


List Task Instance Variables (Show Variables)

List Task Instance Variables (Show Variables): Example URI Properties


UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Used if taskinstancename is specified; Specific task instance with this taskinstancename.

String; URI parameter. 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).

N


taskinstanceid

UUID

UUID of the task instance for which you want to list variables.

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

taskinstancename

Instance Name

Name of the task instance for which you want to list variables.

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

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


List Task Instance Variables (Show Variables): XML and JSON Response Examples

XML

JSON

 XML
<showVariables>
    <instanceName>Complete_Order</instanceName>
    <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
    <status>Running</status>
    <statusDescription></statusDescription>
    <invokedBy>Workflow: Submit_Order_Sub_Workflow</invokedBy>
    <executionUser>ops.admin</executionUser>
    <variables>
        <variable>
            <name>ops_agent_id</name>
            <value>c140722e9a744fcfb648388aa1d7f733</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_attempt</name>
            <value>1</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_avg_estimated_end_time</name>
            <value>2018-10-25 16:49:30 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_hostname</name>
            <value>jmwin7</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_id</name>
            <value>jmwin7:9081-ops6204</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_ipaddr</name>
            <value>10.253.1.49</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_mode</name>
            <value>Active</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_name</name>
            <value>jmwin7:9081-ops6204</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_start_time</name>
            <value>2018-10-25 14:46:33 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cluster_uptime</name>
            <value>2 Hours 1 Minute 5 Seconds</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cmd</name>
            <value>C:\orders\bin\do_order.bat</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_cmd_parms</name>
            <value>C:\orders\342\67.csv</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_custom_field1</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_custom_field2</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_description</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_execution_user</name>
            <value>ops.admin</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_exit_code</name>
            <value>0</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_highest_estimated_end_time</name>
            <value>2018-10-25 16:53:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_launch_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_lowest_estimated_end_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_queued_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_retry_count</name>
            <value>0</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_retry_interval</name>
            <value>60</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_retry_maximum</name>
            <value>0</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_script_id</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_script_name</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_script_parms</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_start_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_status</name>
            <value>RUNNING</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_status_description</name>
            <value></value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_system_identifier</name>
            <value>DEV</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_id</name>
            <value>1540493193934844131JT6DW8IKYH2MM</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_name</name>
            <value>Complete_Order</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_ref_count</name>
            <value>2</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_time_zone</name>
            <value>America/New_York</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_type</name>
            <value>Windows</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_task_type_value</name>
            <value>3</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_top_level_workflow_id</name>
            <value>1540493193934840131AAC49YBBVB4BB</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_vertex_id</name>
            <value>2</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_workflow_id</name>
            <value>1540493193934842131RCD2RVA6OQX9G</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>ops_workflow_name</name>
            <value>Submit_Order_Sub_Workflow</value>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>order_file</name>
            <value>C:\orders\${client_no}\${order_no}.csv</value>
            <valueResolved>\orders\342\67.csv</valueResolved>
            <instanceName>Complete_Order</instanceName>
            <instanceId>1540493193934844131JT6DW8IKYH2MM</instanceId>
        </variable>
        <variable>
            <name>order_no</name>
            <value>67</value>
            <instanceName>Submit_Order_Sub_Workflow</instanceName>
            <instanceId>1540493193934842131RCD2RVA6OQX9G</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>recipients</name>
            <value>${client_contact},orders@stonebranch.com</value>
            <valueResolved>client@stonebranch.com,orders@stonebranch.com</valueResolved>
            <instanceName>Submit_Order_Sub_Workflow</instanceName>
            <instanceId>1540493193934842131RCD2RVA6OQX9G</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>client_contact</name>
            <value>client@stonebranch.com</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>client_no</name>
            <value>342</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>ops_time_zone</name>
            <value>America/New_York</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>ops_trigger_name</name>
            <value>Client_Workflow #TRIGGER#</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>ops_trigger_time</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>ops_trigger_time_tz</name>
            <value>2018-10-25 16:48:00 -0400</value>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>true</inherited>
        </variable>
        <variable>
            <name>recipients</name>
            <value>${client_contact}</value>
            <valueResolved>client@stonebranch.com</valueResolved>
            <instanceName>Client_Workflow</instanceName>
            <instanceId>1540493193934840131AAC49YBBVB4BB</instanceId>
            <inherited>false</inherited>
        </variable>
        <variable>
            <name>DATE_YYYY_MM_DD</name>
            <value>${_date('yyyy-MM-dd')}</value>
            <valueResolved>2018-10-25</valueResolved>
            <inherited>true</inherited>
        </variable>
    </variables>
</showVariables>


 JSON
{
    "instanceName": "Complete_Order",
    "instanceId": "1540493193934844131JT6DW8IKYH2MM",
    "status": "Running",
    "statusDescription": "",
    "invokedBy": "Workflow: Submit_Order_Sub_Workflow",
    "executionUser": "ops.admin",
    "variables": [
        {
            "name": "ops_agent_id",
            "value": "c140722e9a744fcfb648388aa1d7f733",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_attempt",
            "value": "1",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_avg_estimated_end_time",
            "value": "2018-10-25 16:49:30 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_hostname",
            "value": "jmwin7",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_id",
            "value": "jmwin7:9081-ops6204",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_ipaddr",
            "value": "10.253.1.49",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_mode",
            "value": "Active",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_name",
            "value": "jmwin7:9081-ops6204",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_start_time",
            "value": "2018-10-25 14:46:33 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cluster_uptime",
            "value": "2 Hours 2 Minutes 5 Seconds",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cmd",
            "value": "C:\\orders\\bin\\do_order.bat",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_cmd_parms",
            "value": "C:\\orders\\342\\67.csv",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_custom_field1",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_custom_field2",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_description",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_execution_user",
            "value": "ops.admin",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_exit_code",
            "value": "0",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_highest_estimated_end_time",
            "value": "2018-10-25 16:53:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_launch_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_lowest_estimated_end_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_queued_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_retry_count",
            "value": "0",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_retry_interval",
            "value": "60",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_retry_maximum",
            "value": "0",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_script_id",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_script_name",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_script_parms",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_start_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_status",
            "value": "RUNNING",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_status_description",
            "value": "",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_system_identifier",
            "value": "DEV",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_id",
            "value": "1540493193934844131JT6DW8IKYH2MM",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_name",
            "value": "Complete_Order",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_ref_count",
            "value": "2",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_time_zone",
            "value": "America/New_York",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_type",
            "value": "Windows",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_task_type_value",
            "value": "3",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_top_level_workflow_id",
            "value": "1540493193934840131AAC49YBBVB4BB",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_vertex_id",
            "value": "2",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_workflow_id",
            "value": "1540493193934842131RCD2RVA6OQX9G",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "ops_workflow_name",
            "value": "Submit_Order_Sub_Workflow",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "order_file",
            "value": "C:\\orders\\${client_no}\\${order_no}.csv",
            "valueResolved": "\\orders\\342\\67.csv",
            "instanceName": "Complete_Order",
            "instanceId": "1540493193934844131JT6DW8IKYH2MM"
        },
        {
            "name": "order_no",
            "value": "67",
            "instanceName": "Submit_Order_Sub_Workflow",
            "instanceId": "1540493193934842131RCD2RVA6OQX9G",
            "inherited": true
        },
        {
            "name": "recipients",
            "value": "${client_contact},orders@stonebranch.com",
            "valueResolved": "client@stonebranch.com,orders@stonebranch.com",
            "instanceName": "Submit_Order_Sub_Workflow",
            "instanceId": "1540493193934842131RCD2RVA6OQX9G",
            "inherited": true
        },
        {
            "name": "client_contact",
            "value": "client@stonebranch.com",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "client_no",
            "value": "342",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "ops_time_zone",
            "value": "America/New_York",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "ops_trigger_name",
            "value": "Client_Workflow #TRIGGER#",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "ops_trigger_time",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "ops_trigger_time_tz",
            "value": "2018-10-25 16:48:00 -0400",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": true
        },
        {
            "name": "recipients",
            "value": "${client_contact}",
            "valueResolved": "client@stonebranch.com",
            "instanceName": "Client_Workflow",
            "instanceId": "1540493193934840131AAC49YBBVB4BB",
            "inherited": false
        },
        {
            "name": "DATE_YYYY_MM_DD",
            "value": "${_date('yyyy-MM-dd')}",
            "valueResolved": "2018-10-25",
            "inherited": true
        }
    ]
}


Release a Task Instance from Hold


Description

URI

http://host_name/uc/resources/taskinstance/release

HTTP Method

POST

Description

Releases the specified task instance from hold.
 
For Workflow task instances, if the recursive property is set to true, all children task instances will be released from hold.
 
See Releasing a Task Instance from Hold for a description of behavior and restrictions.

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Release a Task Instance from Hold: XML and JSON Examples.

Request Properties

See Release a Task Instance from Hold: Request Properties

Example Response

See Release a Task Instance from Hold: XML and JSON Examples.

Release a Task Instance from Hold: XML and JSON Examples

Examples

XML

JSON

Example Request

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


or

<task-instance>
      <name>Timer 60</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>release</type>
    <success>true</success>
    <info>Command Release executed successfully against task instance "Timer 60".</info>
    <errors />
</command-response>
 JSON
{
  "type": "release",
  "success": true,
  "info": "Command Release executed successfully against task instance \"Task 1\".",
  "errors": ""
}

Release a Task Instance from Hold: 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 release from hold.

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

recursive

n/a

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

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

N


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


Rerun a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/rerun

HTTP Method

POST

Description

Rerun a task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Rerun a Task Instance: XML and JSON Examples.

Request Properties

See Rerun a Task Instance: Request Properties.

Example Response

See Rerun a Task Instance: XML and JSON Examples.

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


or

<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <taskStatus>Success</taskStatus>
      <recursive>true</recursive>
</task-instance>
 JSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

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

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

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

recursive

n/a

Indication of whether or not tasks within sub-workflows will qualify for rerun.

Valid values: true/false. Default is false.

N


taskStatus

Status

If matched task instance is workflow type; List of comma-separated status codes or case-insensitive status names. All tasks within the matching workflow with a matching status will be queued for rerun.

Valid statuses:

  • Start_Failure (120)
  • Cancelled (130)
  • Failed (140)
  • Finished (190)
  • Success (200)

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


Retrieve Task Instance Output


Description

URI

http://host_name/uc/resources/taskinstance/retrieveoutput

HTTP Method

GET

Description

Retrieves the output of a task instance.

Note

When Universal Controller requests the output from the associated Agent, only the output type specified by the outputtype property will be requested. However, the Universal Controller response will also include any output previously associated with the task instance in the database, regardless of output type.

Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example URI Properties

See Retrieve Task Instance Output: Example URI Properties.

Example Response

See Retrieve Task Instance Output: XML and JSON Response Examples.

Retrieve Task Instance Output: XML and JSON Response Examples

XML

JSON

 XML
<taskInstanceOutputs>
	<taskInstanceOutput>
		<attemptCount>1</attemptCount>
		<outputData>
			test output data		
		</outputData>
		<outputType>STDOUT</outputType>
	</taskInstanceOutput>
	<taskInstanceOutput>
		<attemptCount>1</attemptCount>
		<outputData>[empty]</outputData>
		<outputType>STDERR</outputType>
	</taskInstanceOutput>
</taskInstanceOutputs>
 JSON
[
    {
        "attemptCount": 1,
        "outputData": "This is the output.",
        "outputFileName": null,
        "outputType": "STDOUT"
    },
    {
        "attemptCount": 1,
        "outputData": "[empty]",
        "outputFileName": null,
        "outputType": "STDERR"
    }
]

Retrieve Task Instance Output: Example URI Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Used if taskinstancename is specified; Specific task instance with this taskinstancename.

String; URI parameter. 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


numlines

Number of Lines

Number of lines to retrieve.

Integer

N


outputtype

Output Type

Type of task instance output to retrieve.

String; URI parameter. Valid values:

  • As String = OUTERR, As Value = 0
  • As String = STDOUT, As Value = 1
  • As String = STDERR, As Value = 2

Default is OUTERR (0).

Y
(except for z/OS
task instances:
output defaults to
z/OS joblog)


scantext

Scan Text

Scan the data for the text specified and retrieve only that.

String; URI parameter.

N


startline

Start Line

Retrieve data beginning at the line indicated.

Integer; URI parameter. Default is 1.

N


taskinstanceid

UUID

UUID of the task instance for which you want to retrieve output.

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

taskinstancename

Instance Name

Name of the task instance for which you want to retrieve output.

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

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


Set or Modify Wait Time/Duration for Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/settimewait

HTTP Method

POST

Description

Sets or modifies a wait time/duration for a task instance.

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Set or Modify Wait Time/Duration for Task Instance: XML and JSON Examples.

Request Properties

See Set or Modify Wait Time/Duration for Task Instance: Request Properties.

Example Response

See Set or Modify Wait Time/Duration for Task Instance: XML and JSON Examples.

Set or Modify Wait Time/Duration for Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request

 XML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <waitType>time</waitType>
      <waitTime>00:33</waitTime>
      <delayType>duration</delayType>
      <delayDuration>00:00:00:33</delayDuration>
</task-instance>
 JSON
{
"id": "15137106032955949535QDWAW9IA700W",
"waitType": "Time",
"waitTime": "00:33",
"delayType": "duration",
"delayDuration": "00:00:00:33"
}

Example Response

 XML
<command-response>
    <type>set_timewait</type>
    <success>true</success>
    <info>Successfully set timewait for task instance "test task".</info>
    <errors />
</command-response> 
 JSON
{
  "type": "set_timewait",
  "success": true,
  "info": "Successfully set timewait for task instance \"Task 1\".",
  "errors": ""
}

Set or Modify Wait Time/Duration for 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 release from hold.

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


delayDuration

Delay Duration

If waitType is duration; Number of days, hours, minutes, and seconds to delay after starting the task.

Format: DD:HH:MM:SS

Y
(if delayType
is duration)


delaySeconds

Delay Duration In Seconds

If delayType is seconds; Number of seconds to delay after starting the task.

Format: SS

Y
(if delayType
is seconds)


delayType

Delay On Start

Amount of time to delay the start of a task once it is eligible to start.

Valid values:

  • As String = none, As Value = 0
  • As String = duration, As Value = 2
  • As String = seconds, As Value = 3

Y
(unless waitType
is specified.)


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

waitDayConstraint

Wait Day Constraint

If waitTime is time or relative time; Specification for whether or not to advance the wait time to another day.

Valid values:

  • As String = none, As Value = 0
    • If waitType is time; Advance to the next day if calculated wait time is before the current time.
    • If waitType is relative time; Advance to the next day if calculated wait time is before the Trigger/Launch Time.
  • As String = same day/same_day, As Value = 1 (Do not advance day.)
  • As String = next day/next_day, As Value = 2 (Advance to the next day.)
  • As String = next business day/next_business_day, As Value = 3 (Advance to the next business day.)
  • As String = sunday, As Value = 4 (If today is not Sunday, advance to next Sunday.)
  • As String = monday, As Value = 5 (If today is not Monday, advance to next Monday.)
  • As String = tuesday, As Value = 6 (If today is not Tuesday, advance to next Tuesday.)
  • As String = wednesday, As Value = 7 (If today is not Wednesday, advance to next Wednesday.)
  • As String = thursday, As Value = 8 (If today is not Thursday, advance to next Thursday.)
  • As String = friday, As Value = 9 (If today is not Friday, advance to next Friday.)
  • As String = saturday, As Value = 10 (If today is not Saturday, advance to next Saturday.)

N


waitDuration

Wait Duration

If waitType is duration; Number of days, hours, minutes, and seconds to wait before starting the task.

Format: DD:HH:MM:SS

Y
(if {{waitType
is duration)


waitSeconds

Wait Duration In Seconds

If waitType is seconds; Number of seconds to wait before starting the task.

Format: SS

Y
(if waitType
is seconds)


waitTime

Wait Time

If waitType is time or relative time; Number of hours and minutes to wait before starting the task.

Format: HH:MM

Y
(if waitType
is time or
relative time)


waitType

Wait To Start

Amount of time to wait before starting a task after it has been launched.

Valid values:

  • As String = none, As Value = 0
  • As String = time, As Value = 1
  • As String = duration, As Value = 2
  • As String = seconds, As Value = 3
  • As String = relative time, As Value = 4

Y
(unless delayType
is specified.)


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


Set Priority for a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/setpriority

HTTP Method

POST

Description

Set priority for a task instance (Linux/Unix, Windows, Universal, or z/OS).
 
See Changing the Priority of a Task Instance for a description of behavior and restrictions.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Set Priority for a Task Instance: XML and JSON Examples.

Request Properties

See Set Priority for a Task Instance: Request Properties.

Example Response

See Set Priority for a Task Instance: XML and JSON Examples.

Set Priority for a Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request

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


or

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

Example Response

 XML
<command-response>
    <type>set_priority_(low | medium | high}</type>
    <success>true</success>
    <info>Command Set Priority (low | medium | high} executed successfully against task instance "test".</info>
    <errors />
</command-response>


 JSON
{
  "type": "set_priority_high",
  "success": true,
  "info": "Command Set Priority High executed successfully against task instance \"Task 1\".",
  "errors": ""
}


Set Priority for 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 set a priority for.

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

priorityType

n/a

Sets the priority for this task instance.

Valid values: low, medium, high; Case-insensitive.

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


Skip a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/skip

HTTP Method

POST

Description

Skip a task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Skip a Task Instance: XML and JSON Examples.

Request Properties

See Skip a Task Instance: Request Properties.

Example Response

See Skip a Task Instance: XML and JSON Examples.

Skip 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": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

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

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

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


Skip a Task Instance Path


Description

URI

http://host_name/uc/resources/taskinstance/skippath

HTTP Method

POST

Description

Skip a task instance and all of its dependent task instances.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Skip a Task Instance Path: XML and JSON Examples.

Request Properties

See Skip a Task Instance Path: Request Properties.

Example Response

See Skip a Task Instance Path: XML and JSON Examples.

Skip a Task Instance Path: 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": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

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

Skip a Task Instance Path: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Specific task instance with this task instance name whose path you want to skip.

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


Unskip a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/unskip

HTTP Method

POST

Description

Unskip a task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Unskip a Task Instance: XML and JSON Examples.

Request Properties

See Unskip a Task Instance: Request Properties.

Example Response

See Unskip a Task Instance: XML and JSON Examples.

Unskip 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": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

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

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

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



Update a Task Instance Operational Memo

Update a Task Instance Operational Memo: Text/Plain Examples 

Examples

Text/Plain

Example Request Body

Ticket# 15243

Example Response Body

Updated the operational memo for record with task instance id 15832561207058159886SCGSSDF53H7Q.

Update a Task Instance Operational Memo: Example URI Properties


UI Field Name

Description

Specifications

Required

Mutually Exclusive With

criteria

n/a

Used if taskinstancename is specified; Specific task instance with this taskinstancename.

String; URI parameter. 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).

N


taskinstanceid

UUID

UUID of the task instance for which you want to update the Operational Memo.

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

taskinstancename

Instance Name

Name of the task instance for which you want to update the Operational Memo.

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

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