Versions Compared

Key

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

...

...

...

...


Panel
Table of Contents
maxlevel1

...

...

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

Anchor

...

Status Types
Status Types
Task Instance Status Types

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

Note
titleNote

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

...

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.

...

Examples

...

XML

...

JSON

...

Example Request

...

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

...

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

...

titleJSON
{
"name": "Timer 60",
"criteria": "Newest Instance",
"workflowInstanceName": "test"
}

...

Example Response

...

Expand
titleXML
<command-response>
      <type>cancel</type>
      <success>true</success>
      <info>Command Cancel executed successfully against task instance "test".</info>
      <errors />
</command-response>

...

Expand
titleJSON
{
  "type": "cancel",
  "success": true,
  "info": "Command Cancel executed successfully against task instance \"Timer 60\".",
  "errors": ""
}

...

Property

...

UI Field Name

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

n/a

...

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

Valid values:

Default is Oldest Active Instance (1).
 

Note
titleNote

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

...

N

...

n/a

...

sys_id used within the Controller to identify this task instance.

...

Y
(unless name
is specified)

...

name

...

Instance Name

...

Name of the task instance.

...

Y
(unless id
is specified)

...

id

...

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

...

Description

...

URI

...

HTTP Method

...

POST

...

Description

...

Clears all dependencies of a task instance.

...

Example URI

...

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.

...

Examples

...

XML

...

JSON

...

Example Request

...

titleXML

...

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.

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

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

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

Anchor
Running
Running
Running

80

All

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

Anchor
Running/Problems
Running/Problems
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.

Anchor
Start Failure
Start Failure
Start Failure

120

All

The task was unable to start.

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

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

Anchor
Time Wait
Time Wait
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.

Anchor
Cancel a Task Instance
Cancel a Task Instance
Cancel a Task Instance

Note
titleNote

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.

Anchor
Cancel a Task Instance XML and JSON Examples
Cancel a Task Instance XML and JSON Examples
Cancel a Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request


Expand
titleXML


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

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



Expand
titleJSON


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



Example Response


Expand
titleXML
<command-response>
      <type>clear_all_dependencies<<type>cancel</type>
      <success>true</success>
      <info>Command Clear All DependenciesCancel executed successfully against task instance "Timer 60test".</info>
      <errors />
</command-response>



Expand
titleJSON
{
  "type": "clear_all_dependenciescancel",
  "success": true,
  "info": "Command ClearCancel All Dependencies executed successfully against task instance \"Timer 60\".",
  "errors": ""
}


Anchor

...

Cancel a Task Instance Request Properties

...

Cancel a Task Instance Request Properties

...

Cancel a Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CADCTI
criteria - CADCTI
criteria

n/a

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

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
titleNote

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


N


Anchor
id - CADCTI
id - CADCTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CADCTI
name - CADCTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - CADCTI
workflowInstanceName - CADCTI
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


Anchor
Clear

...

All Dependencies
Clear

...

All Dependencies
Clear

...

All Dependencies


Description

URI

http://host_name/uc/resources/taskinstance/clearexclusivecleardependencies

HTTP Method

POST

Description

Clears all exclusive dependencies of a task instance.

Authentication

HTTP Basic

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Exclusive All Dependencies: XML and JSON Examples.

Request Properties

See Clear Exclusive All Dependencies: Request Properties.

Example Response

See Clear Exclusive All Dependencies: XML and JSON Examples.

Anchor
Clear

...

All Dependencies XML and JSON Examples
Clear

...

All Dependencies XML and JSON Examples
Clear

...

All Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request


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

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



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



Example Response


Expand
titleXML
<command-response>
      <type>clear_all_exclusive<dependencies</type>
      <success>true</success>
      <info>Command Clear All ExclusiveDependencies executed successfully against task instance "Timer 60".</info>
      <errors />
</command-response> 



Expand
titleJSON
{
  "type": "clear_all_exclusivedependencies",
  "success": true,
  "info": "Command Clear All ExclusiveDependencies executed successfully against task instance \"Timer 60\".",
  "errors": ""
}


Anchor
Clear

...

All Dependencies Request Properties
Clear

...

All Dependencies Request Properties
Clear

...

All Dependencies: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CEDCAD
criteria - CEDCAD
criteria

n/a

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

Valid values:Default is

  • As String = Oldest Active Instance
(1
  • , 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
titleNote

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


N


Anchor
id - CEDCAD
id - CEDCAD
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CEDCAD
name - CEDCAD
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - CEDCAD
workflowInstanceName - CEDCAD
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


Anchor
Clear

...

Exclusive Dependencies
Clear

...

Exclusive Dependencies
Clear

...

Exclusive Dependencies


Description

URI

http://host_name/uc/resources/taskinstance/clearpredecessorsclearexclusive

HTTP Method

POST

Description

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

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Predecessor Exclusive Dependencies: XML and JSON Examples.

Request Properties

See Clear Predecessor Exclusive Dependencies: Request Properties.

Example Response

See Clear Predecessor Exclusive Dependencies: XML and JSON Examples.

Anchor
Clear

...

Exclusive Dependencies XML and JSON Examples
Clear

...

Exclusive Dependencies XML and JSON Examples
Clear

...

Exclusive Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request


Expand
titleXML
<task-instance>
      	<id>1464817327170011848D633V6106ENQ7</id>
    
 <predecessorName>*</predecessorName>
</task-instance>


or

<task-instance>
      <name>Timer 60</name>
      <criteria>Newest Instance</criteria>
      <workflowinstancenameworkflowInstanceName>test</workflowinstancename> 
      <predecessorName>*</predecessorName>workflowInstanceName> 
</task-instance>



Expand
titleJSON
{
"name": "Timer 60",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test",
"predecessorName": "Task 1"
}


Example Response


Expand
titleXML
<command-response>
      <type>set<type>clear_edges_satisfied<exclusive</type>
      <success>true</success>
      <info>Command Clear PredecessorsExclusive executed successfully against task instance "Timer 60".</info>
      <errors />
</command-response> 



Expand
titleJSON
{
  "type": "setclear_edge_satisfiedexclusive",
  "success": true,
  "info": "Successfully marked the dependency as satisfiedCommand Clear Exclusive executed successfully against task instance \"Timer 60\".",
  "errors": ""
}


Anchor
Clear

...

Exclusive Dependencies Request Properties
Clear

...

Exclusive Dependencies Request Properties
Clear

...

Exclusive Dependencies: Request Properties

workflowinstancename

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CPDCED
criteria - CPDCED
criteria

n/a

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

Valid values:Default is

  • As String = Oldest Active Instance
(1
  • , 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
titleNote

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


N


Anchor
id - CPDCED
id - CPDCED
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CPDCED
name - CPDCED
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
predecessorName - CPDpredecessorName - CPD
predecessorName

n/a

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

* = Clears dependencies from all predecessor task instances.

Y

Anchor
workflowInstanceName - CPDworkflowInstanceName - CPD
workflowInstanceName - CED
workflowInstanceName - CED
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


Anchor
Clear

...

Predecessor Dependencies
Clear

...

Predecessor Dependencies
Clear

...

Predecessor Dependencies


Description

URI

http://host_name/uc/resources/taskinstance/cleartimewaitclearpredecessors

HTTP Method

POST

Description

Clears the time dependency all predecessor dependencies of a task instance in a Workflow.

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Time DependencyPredecessor Dependencies: XML and JSON Examples.

Request Properties

See Clear Time Dependency Predecessor Dependencies: Request Properties.

Example Response

See Clear Time DependencyPredecessor Dependencies: XML and JSON Examples.

Anchor
Clear

...

Predecessor Dependencies XML and JSON Examples
Clear

...

Predecessor Dependencies XML and JSON Examples
Clear

...

Predecessor Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request


Expand
titleXML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <predecessorName>*</predecessorName>
</task-instance>


or

<task-instance>
      <name>Test>Timer task<60</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
      <predecessorName>*</predecessorName>
</task-instance>



Expand
titleJSON
{
"name": "TaskTimer 160",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
},
"predecessorName": "Task 1"
}


Example Response


Expand
titleXML
<command-response>
      <type>clear<type>set_edges_timewait<satisfied</type>
      <success>true</success>
      <info>Command Clear Time Wait/DelayPredecessors executed successfully against task instance "TestTimer task60".</info>
      <errors />
</command-response> 



Expand
titleJSON
{
  "type": "clearset_edge_timewaitsatisfied",
  "success": true,
  "info": "CommandSuccessfully Clearmarked Timethe Wait/Delaydependency executed successfully against task instance \"Task 1\"as satisfied.",
  "errors": ""
}


Anchor
Clear

...

Predecessor Dependencies Request Properties
Clear

...

Predecessor Dependencies Request Properties
Clear

...

Predecessor Dependencies: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CTDCPD
criteria - CTDCPD
criteria

n/a

Specific task instance with this task instance name for which you want to clear time dependencypredecessor 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
titleNote

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


N


Anchor
id - CTDCPD
id - CTDCPD
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CTDCPD
name - CTDCPD
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
predecessorName - CPD
predecessorName - CPD
predecessorName

n/a

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

* = Clears dependencies from all predecessor task instances.

Y


Anchor
workflowInstanceName - CTDCPD
workflowInstanceName - CTDCPD
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


Anchor
Clear

...

Time Dependency
Clear

...

Time Dependency
Clear

...

Time Dependency

clearresources


Description

URI

http://host_name/uc/resources/taskinstance/clearresourcescleartimewait

HTTP Method

POST

Description

Clears virtual resource dependencies 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 Virtual Resource DependenciesTime Dependency: XML and JSON Examples.

Request Properties

See Clear Virtual Resource DependenciesTime Dependency : Request Properties.

Example Response

See Clear Virtual Resource DependenciesTime Dependency: XML and JSON Examples.

Anchor
Clear

...

Time Dependency XML and JSON Examples
Clear

...

Time Dependency XML and JSON Examples
Clear

...

Time Dependency: XML and JSON Examples

Examples

XML

JSON

Example Request


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

     <resourceName>V1</resourceName>
</task-instance>


or

<task-instance>
      <name>Timer>Test 60<task</name>
      <criteria>Newest Instance</criteria>
      <workflowInstanceName>test</workflowInstanceName> 
      <resourceName>V1</resourceName>
</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test",
"resourceName": "V1"
}


Example Response


Expand
titleXML
<command-response>
      <type>clear_resources<timewait</type>
      <success>true</success>
      <info>Command Clear Time ResourcesWait/Delay executed successfully against task instance "TimerTest 60task".</info>
      <errors />
</command-response> 



Expand
titleJSON
{
  "type": "clear_resourcestimewait",
  "success": true,
  "info": "Command Clear Time ResourcesWait/Delay executed successfully against task instance \"Task 1\".",
  "errors": ""
}


Anchor
Clear

...

Time Dependency Request Properties
Clear

...

Time Dependency Request Properties
Clear

...

Time Dependency: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CVRCTD
criteria - CVRCTD
criteria

n/a

Specific task instance with this task instance name for which you want to clear virtual resource dependenciestime 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
titleNote

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


N


Anchor
id - CVRCTD
id - CVRCTD
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CVRCTD
name - CVRCTD
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
resourceName workflowInstanceName - CVRCTDresourceName
workflowInstanceName - CVR
resourceName

n/a

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

* = Clears dependencies from all virtual resources.

Y

Anchor
workflowInstanceName - CVRworkflowInstanceName - CVRCTD
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


Anchor

...

Clear Virtual Resource Dependencies
Clear Virtual Resource Dependencies
Clear Virtual Resource Dependencies


Description

URI

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

HTTP Method

DELETEPOST

Description

Deletes the specified Clears virtual resource dependencies of a task instance. For Workflow task instances, if the recursive property is set to true, all children task instances will be removed.

Authentication

HTTP Basic

Example URIhttp://localhost:8080/uc/resources/taskinstance/clearresources

Consumes Content-Type

application/xml, application/json

Example URI

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

Produces Content-Type

application/xml, application/json

Example Request

See Delete a Task Instance Clear Virtual Resource Dependencies: XML and JSON Examples.

Request Properties

See Delete a Task Instance Clear Virtual Resource Dependencies: Request Properties.

Example Response

Status 200 /OK
Task instance(s) deleted successfully

See Clear Virtual Resource Dependencies: XML and JSON Examples.

Anchor

...

Clear Virtual Resource Dependencies XML and JSON Examples

...

Clear Virtual Resource Dependencies XML and JSON Examples

...

Clear Virtual Resource Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request


Delete Task instance by task instance id.
Expand
titleXML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <resourceName>V1</resourceName>
</task-instance>

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


or

<task-instance>
      <id>14483224900880190549PGHP23IR12MO</idname>Timer 60</name>
      <recursive>true</recursive>
</task-instance>

 
 
Delete Task instance by task instance name.

<task-instance>criteria>Newest Instance</criteria>
      <name>Timer 60</nameworkflowInstanceName>test</workflowInstanceName> 
     <criteria>Newest Instance</criteria <resourceName>V1</resourceName>
</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test",
"resourceName": "V1"
}

...

criteria

Valid values:

Default is Oldest Instance (3).
 


Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - DTIcriteria - DTI

n/a

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

Note
titleNote

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

N

Anchorid - DTIid - DTI

Example Response


Expand
titleXML
<command-response>
      <type>clear_resources</type>
      <success>true</success>
      <info>Command Clear Resources executed successfully against task instance "Timer 60".</info>
      <errors />
</command-response>



Expand
titleJSON
{
  "type": "clear_resources",
  "success": true,
  "info": "Command Clear Resources executed successfully against task instance \"Task 1\".",
  "errors": ""
}


Anchor
Clear Virtual Resource Dependencies Request Properties
Clear Virtual Resource Dependencies Request Properties
Clear Virtual Resource Dependencies: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CVR
criteria - CVR
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
titleNote

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


N


Anchor
id - CVR
id - CVR
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - DTICVR
name - DTICVR
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
recursive resourceName - DTICVRrecursive
resourceName - DTICVR
recursiveresourceName

n/a

For Workflow task instances only; Specification for whether or not to delete all children task instances Name of the virtual resource for which you want to clear dependency.

* = Clears dependencies from all virtual resources.

Y


Anchor
workflowInstanceName - CVR
workflowInstanceName - CVR
workflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

Boolean; Valid values: true/false. Default is falseYou 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


Anchor

...

Delete a Task Instance

...

Delete a Task Instance

...

Delete a Task Instance


Description

URI

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

HTTP Method

POSTDELETE

Description

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

Example URI

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

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

Produces Content-Type

application/xml, application/jsonExample URI

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

Example Request

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

Request Properties

See Force Finish Delete a Task Instance: Request Properties.

Example ResponseSee Force Finish a Task Instance: XML and JSON Examples

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

Anchor

...

Delete a Task Instance XML and JSON Examples

...

Delete a Task Instance XML and JSON Examples

...

Delete a Task Instance: XML and JSON Examples

Example Request

Examples

XML

JSON


Expand
titleXML

Delete Task instance by task instance id.


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


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


<task-instance>
      <name>Timer 60</nameid>14483224900880190549PGHP23IR12MO</id>
      <haltrecursive>true</halt>recursive>
</task-instance>


 
 
Delete Task instance by task instance name.


<task-instance>
      <criteria>Newestname>Timer Instance<60</criterianame>
      <workflowInstanceName>test</workflowInstanceNamecriteria>Newest Instance</criteria>

</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"halt": "True",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}

Example Response

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

...

criteria

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - FFcriteria - FF

n/a

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

Valid values:

Default is Oldest Active Instance (1).
 

Note
titleNote
Values with an underscore characters ( _ )

}


Anchor
Delete a Task Instance Request Properties
Delete a Task Instance Request Properties
Delete a Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - DTI
criteria - DTI
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
titleNote

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


N


Anchor
halt - FFhalt - FF
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

Anchor
id - FFid - DTI
id - FFDTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - FFDTI
name - FFDTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName recursive - FFDTIworkflowInstanceName
recursive - FFDTI
workflowInstanceNamerecursive

Workflow

Name of the parent Workflow n/a

For Workflow task instances only; Specification for whether or not to delete all children task instances 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.

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

N


Anchor
Force Finish

...

a Task Instance
Force Finish

...

a Task Instance
Force Finish

...

a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/forcefinishcancelforcefinish

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

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.

Anchor
Force Finish

...

a Task Instance XML and JSON Examples
Force Finish

...

a Task Instance XML and JSON Examples
Force Finish

...

a Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request


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



Expand
titleJSON
{
"name": "Task 1",
"halt": "True",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}


Example Response


Expand
titleXML
<command-response>
    <type>force_finish_cancel<finish</type>
    <success>true</success>
    <info>Command Force Finish/Cancel executed successfully against task instance "test".</info>
    <errors />
</command-response>



Expand
titleJSON
{
  "type": "force_finish_cancel",
  "success": true,
  "info": "Command Force Finish/Cancel executed successfully against task instance \"Task 1\".",
  "errors": ""
}


Anchor
Force Finish

...

a Task Instance Request Properties
Force Finish

...

a Task Instance Request Properties
Force Finish

...

a Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - FFCFF
criteria - FFCFF
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
titleNote

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


N


Anchor
halt - FFCFF
halt - FFCFF
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


Anchor
id - FFCFF
id - FFCFF
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - FFCFF
name - FFCFF
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - FFCFF
workflowInstanceName - FFCFF
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


Anchor

...

Force Finish Cancel a Task Instance

...

Force Finish Cancel a Task Instance

...

Force Finish/Cancel a Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/holdforcefinishcancel

HTTP Method

POST

Description

Hold 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/holdforcefinishcancel

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

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

Example Response

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

Anchor

...

Force Finish Cancel a Task Instance XML and JSON Examples

...

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


Expand
titleXML
<task-instance>
      <id>410d6c0bc0a801c901838d8ac43b3279<>1464817327170011848D633V6106ENQ7</id>
</task-instance>


or

<task-instance>
      <name>Timer 60</name>
      <halt>true</halt>
      <criteria>Newest Instance</criteria>
      <workflowinstancenameworkflowInstanceName>test</workflowinstancenameworkflowInstanceName> 
</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"halt": "True",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test"
}


Example Response


Expand
titleXML
<command-response>
    <type>hold<<type>force_finish_cancel</type>
    <success>true</success>
    <info>Command Force HoldFinish/Cancel executed successfully against task instance "test".</info>
    <errors />
</command-response>



Expand
titleJSON
{
  "type": "holdforce_finish_cancel",
  "success": true,
  "info": "Command Force HoldFinish/Cancel executed successfully against task instance \"Task 1\".",
  "errors": ""
}


Anchor

...

Force Finish Cancel a Task Instance Request Properties

...

Force Finish Cancel a Task Instance Request Properties

...

Force Finish/Cancel a Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - HTIFFC
criteria - HTIFFC
criteria

n/a

Specific task instance with this task instance name that you want to holdforce 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
titleNote

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


N


Anchor
halt - FFC
halt - FFC
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


Anchor
id - HTIFFC
id - HTIFFC
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - HTIFFC
name - HTIFFC
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - HTIFFC
workflowInstanceName - HTIFFC
workflowinstancenameworkflowInstanceName

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


Anchor

...

Hold a

...

Task Instance

...

Hold a

...

Task Instance

...

Hold a

...

Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/setcompletedhold

HTTP Method

POST

Description

Issues a Set Completed command for a Manual Task Hold a task instance.

Example URI

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

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 Hold a Manual Task Instance: XML and JSON Examples.

Request Properties

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

Example Response

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

Anchor

...

Hold a

...

Task Instance XML and JSON Examples

...

Hold a

...

Task Instance XML and JSON Examples

...

Hold a

...

Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request


Expand
titleXML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7<>410d6c0bc0a801c901838d8ac43b3279</id>
</task-instance>


or

<task-instance>
      <name>test>Timer manual<60</name>
      <criteria>Newest Instance</criteria>
      <workflowinstancenameworkflowInstanceName>test</workflowinstancenameworkflowInstanceName> 
</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test"
}


Example Response


Expand
titleXML
<command-response>
    <type>set_manual_completed<<type>hold</type>
    <success>true</success>
    <info>Command Set CompletedHold executed successfully against task instance "test".</info>
    <errors />
</command-response>



Expand
titleJSON
{
  "type": "set_manual_completedhold",
  "success": true,
  "info": "Command Set CompletedHold executed successfully against task instance \"Task 1\".",
  "errors": ""
}


Anchor

...

Hold a

...

Task Instance Request Properties

...

Hold a

...

Task Instance Request Properties

...

Hold a

...

Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - ISCCHTI
criteria - ISCCHTI
criteria

n/a

Specific task instance with this task instance name that you want to issue a Set Completed command forhold.

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
titleNote

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


N


Anchor
id - ISCCHTI
id - ISCCHTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - ISCCHTI
name - ISCCHTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - ISCCHTI
workflowInstanceName - ISCCHTI
workflowinstancenameworkflowInstanceName

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


Anchor
Issue Set

...

Completed Command for a Manual Task Instance
Issue Set

...

Completed Command for a Manual Task Instance
Issue Set

...

Completed Command for a Manual Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/setstartedsetcompleted

HTTP Method

POST

Description

Issues a Set Started Completed command for a Manual Task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

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

Example Response

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

Anchor
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
Issue Set

...

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

Examples

XML

JSON

Example Request


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


or

<task-instance>
      <name>test manual</name>
      <criteria>Newest Instance</criteria>
      <workflowinstancenameworkflowInstanceName>test</workflowinstancenameworkflowInstanceName> 
</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test"
}


Example Response


Expand
titleXML
<command-response>
    <type>set_manual_started<completed</type>
    <success>true</success>
    <info>Command Set StartedCompleted executed successfully against task instance "test".</info>
    <errors />
</command-response>



Expand
titleJSON
{
  "type": "set_manual_startedcompleted",
  "success": true,
  "info": "Command Set StartedCompleted executed successfully against task instance \"Task 1\".",
  "errors": ""
}


Anchor
Issue Set

...

Completed Command for a Manual Task Instance Request Properties
Issue Set

...

Completed Command for a Manual Task Instance Request Properties
Issue Set

...

Completed Command for a Manual Task Instance: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - ISSCISCC
criteria - ISSCISCC
criteria

n/a

Specific task instance with this task instance name that you want to issue a Set Started 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
titleNote

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


N


Anchor
id - ISSCISCC
id - ISSCISCC
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - ISSCISCC
name - ISSCISCC
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - ISSCISCC
workflowInstanceName - ISSCISCC
workflowinstancenameworkflowInstanceName

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


Anchor

...

Issue Set Started Command for a Manual Task Instance
Issue Set Started Command for a Manual Task Instance
Issue Set Started Command for a Manual Task Instance


Description

URI

http://host_name/uc/resources/taskinstance/listsetstarted

HTTP Method

POST

Description

Retrieves information on task instances matching specific search criteria.

Authentication

HTTP BasicIssues a Set Started command for a Manual Task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See List Task InstancesIssue Set Started Command for a Manual Task Instance: XML and JSON Request Examples.

Request Properties

See List Task InstancesIssue Set Started Command for a Manual Task Instance: Request Properties.

Example Response

See List Task InstancesIssue Set Started Command for a Manual Task Instance: XML and JSON Response Examples.

Anchor

...

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

...

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

List Task Instances Example Request

Examples

XML

JSON

Anchor
List Task Instances Example Request

Example Request


Expand
titleXML

Task instance with multiple query criteria.

<task-
instance-query-filter>
instance>
      <
name>B-06884*</name>
id>1464817327170011848D633V6106ENQ7</id>
</task-instance>


or

<task-instance>
      <
status>!45</status
name>test manual</name>
      <
customField1>My*</customField1
criteria>Newest Instance</criteria>
      <
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> 
 
Expand
titleJSON

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"
 }    
workflowInstanceName>test</workflowInstanceName> 
</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test"
}


Example Response


Expand
titleXML
<command-response>
    <type>set_manual_started</type>
    <success>true</success>
    <info>Command Set Started executed successfully against task instance "test".</info>
    <errors />
</command-response>



Expand
titleJSON
{
  "type": "set_manual_started",
  "success": true,
  "info": "Command Set Started executed successfully against task instance \"Task 1\".",
  "errors": ""
}


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

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - ISSC
criteria - ISSC
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
titleNote

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


N


Anchor
id - ISSC
id - ISSC
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - ISSC
name - ISSC
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - ISSC
workflowInstanceName - ISSC
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


Anchor
List Task Instances
List Task Instances
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.

Anchor
List Task Instances XML and JSON Examples
List Task Instances XML and JSON Examples
List Task Instances: XML and JSON Examples

Example Response

Examples

XML

JSON

Anchor
List Task Instances Example Request
List Task Instances Example Request
Example Request


Expand
titleXML

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": "1513644026115413351LS9ACLESSKLXZ" }
<sysId>1448396297341015141TB2QF51JBYM8V</sysId>
</task-instance-query-filter> 


 
 
Task instance with multiple query criteria.

{


<task-instance-query-filter>
      
"name": "*",
<name>*</name>
      
"status": "200", "type": "windows",
<type>windows</type>
      <agentName>test 
"agentName": "Mark-4 - AGNT0002",
agent</agentName>
      
"lateStart": true, "lateFinish": false,"earlyFinish": false }
<earlyFinish>false</earlyFinish>
</task-instance-query-filter> 


 
All task instances that either started late or finished late.

{


<task-instance-query-filter>
      
"name": "*",
<name>*</name>
      
"late": true }
<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>*</name>
      
"lateEarly": true }
<lateEarly>true</lateEarly>
</task-instance-query-filter>


 
All task instances that neither started late nor finished late.


<task-instance-query-filter>
{
      
"name": "*",
<name>*</name>
      
"late": false }
<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>*</name>
      
"lateEarly": false }
Anchor
List Task Instances Example ResponseList Task Instances Example Response
Expand
titleXML
Panel
Expand
titleJSON
Panel

...

agentNamebusinessServicescustomField1customField2executionUserinstanceNumberlatelateEarly

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
agentName - LTIagentName - LTI

Agent

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

N

Anchor
businessServices - LTIbusinessServices - LTI

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N

Anchor
customField1 - LTIcustomField1 - LTI

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

Anchor
customField2 - LTIcustomField2 - LTI

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

Anchor
executionUser - LTIexecutionUser - LTI

Execution User

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

System-supplied.

N

Anchor
instanceNumber - LTIinstanceNumber - LTI

Instance Number

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

Integer value.

N

Anchor
late - LTIlate - LTI

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

Anchor
lateEarly - LTIlateEarly - LTI

Started Late / Finished Late / Finished Early

Indication of whether or not to list all task instances that
<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>


 

* Workflows cannot go to Failed status.

...

namestatusstatusDescriptionsysIdtaskIdtaskNametemplateIdtemplateNametriggerIdtriggerNametypeupdatedTime

Valid values:

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

Description

URI

http://host_name/uc/resources/taskinstance/showvariables

HTTP Method

GET

Description

Retrieve the variables for a specific task instance. (Comparable to the Show Variables functionality in the user interface.)

Authentication

HTTP Basic

Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example URI Properties

See List Task Instance Variables: Example URI Properties.

Example Response

See List Task Instance Variables: XML and JSON Response Examples.


Expand
titleJSON

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.

Valid values: true/false.

N

Anchor
name - LTIname - LTI

Instance name

Name or partial name of one or more task instances.

Wildcards are supported.

Y
(unless sysId
is specified)

sysId

Anchor
status - LTIstatus - LTI

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

Anchor
statusDescription - LTIstatusDescription - LTI

Status Description

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

Wildcards are supported.

N

Anchor
sysId - LTIsysId - LTI

n/a

sys_id used within the Controller to identify a task instance.

Y
(unless name
is specified)

name

Anchor
taskId - LTItaskId - LTI

n/a

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

N

taskName

Anchor
taskName - LTItaskName - LTI

n/a

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

N

taskId

Anchor
templateIdtemplateIdn/aID used within the controller to identify a template.If a templateId or templateName is specified, List task returns a list of tasks within the Universal templateNtemplateName
Anchor
templateNametemplateNameTemplate NameName of a template.If a templateId or templateName is specified, List task returns a list of tasks within the Universal templateNtemplateId
Anchor
triggerId - LTItriggerId - LTI

n/a

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

N

triggerName

Anchor
triggerName - LTItriggerName - LTI

n/a

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

N

triggerId

Anchor
type - LTItype - LTI

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

Anchor
updateTime - LTIupdateTime - LTI

n/a

If updatedTimeType = Offset; -offset period.

Note
titleNote

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

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

AnchorupdatedTimeType - LTIupdatedTimeType - LTIupdatedTimeType

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

N

AnchorworkflowDefinitionId - LTIworkflowDefinitionId - LTIworkflowDefinitionId

n/a

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

N

workflowDefinitionName

AnchorworkflowDefinitionName - LTIworkflowDefinitionName - LTIworkflowDefinitionName

n/a

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

N

workflowDefinitionId

AnchorworkflowInstanceCriteria - LTIworkflowInstanceCriteria - LTIworkflowInstanceCriteria

n/a

Specification for how workflowinstancename finds the matching workflow.

Valid values:

Default is Oldest Active Instance (1).
 

Note
titleNote

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

N

AnchorworkflowInstanceId - LTIworkflowInstanceId - LTIworkflowInstanceId

n/a

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

N

workflowInstanceName

AnchorworkflowInstanceName - LTIworkflowInstanceName - LTIworkflowInstanceName

Workflow

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

N

workflowInstanceId

...

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

Note
titleNote

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.

...

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.

...

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.

...

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

...

80

...

All

...

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

...

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.

...

120

...

All

...

The task was unable to start.

...

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.

...

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.

...

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.


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

}




Anchor
List Task Instances Example Response
List Task Instances Example Response
Example Response


Expand
titleXML


Panel


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









Expand
titleJSON


Panel


Html bobswift
<pre>
{
  "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",
  "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"
}
</pre>








Anchor
List Task Instances Request Properties
List Task Instances Request Properties
List Task Instances: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
agentName - LTI
agentName - LTI
agentName

Agent

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


N


Anchor
businessServices - LTI
businessServices - LTI
businessServices

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N


Anchor
customField1 - LTI
customField1 - LTI
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


Anchor
customField2 - LTI
customField2 - LTI
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


Anchor
executionUser - LTI
executionUser - LTI
executionUser

Execution User

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

System-supplied.

N


Anchor
instanceNumber - LTI
instanceNumber - LTI
instanceNumber

Instance Number

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

Integer value.

N


Anchor
late - LTI
late - LTI
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


Anchor
lateEarly - LTI
lateEarly - LTI
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


Anchor
name - LTI
name - LTI
name

Instance name

Name or partial name of one or more task instances.

Wildcards are supported.

Y
(unless sysId
is specified)

sysId

Anchor
status - LTI
status - LTI
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


Anchor
statusDescription - LTI
statusDescription - LTI
statusDescription

Status Description

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

Wildcards are supported.

N


Anchor
sysId - LTI
sysId - LTI
sysId

n/a

sys_id used within the Controller to identify a task instance.


Y
(unless name
is specified)

name

Anchor
taskId - LTI
taskId - LTI
taskId

n/a

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


N

taskName

Anchor
taskName - LTI
taskName - LTI
taskName

n/a

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


N

taskId

Anchor
templateId - LTI
templateId - LTI
templateId

n/aID 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.NtemplateName

Anchor
templateName - LTI
templateName - LTI
templateName

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

Anchor
triggerId - LTI
triggerId - LTI
triggerId

n/a

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


N

triggerName

Anchor
triggerName - LTI
triggerName - LTI
triggerName

n/a

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


N

triggerId

Anchor
type - LTI
type - LTI
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


Anchor
updateTime - LTI
updateTime - LTI
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
titleNote

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


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


Anchor
updatedTimeType - LTI
updatedTimeType - LTI
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


Anchor
workflowDefinitionId - LTI
workflowDefinitionId - LTI
workflowDefinitionId

n/a

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


N

workflowDefinitionName

Anchor
workflowDefinitionName - LTI
workflowDefinitionName - LTI
workflowDefinitionName

n/a

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


N

workflowDefinitionId

Anchor
workflowInstanceCriteria - LTI
workflowInstanceCriteria - LTI
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
titleNote

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


N


Anchor
workflowInstanceId - LTI
workflowInstanceId - LTI
workflowInstanceId

n/a

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


N

workflowInstanceName

Anchor
workflowInstanceName - LTI
workflowInstanceName - LTI
workflowInstanceName

Workflow

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


N

workflowInstanceId

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

Anchor
LTIA XML JSON Examples
LTIA XML JSON Examples
List Task Instances - Advanced: XML and JSON Request Examples

Examples

XML

JSON

Anchor
List Task Instances Example Request
List Task Instances Example Request
Example Request


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






Expand
titleJSON
{
      "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": "*" }



Anchor
List Task Instances Example Response
List Task Instances Example Response
Example Response


Expand
titleXML
<?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>



Expand
titleJSON
[
    {
        "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"
    }
]


Anchor
LTIA RP
LTIA RP
List Task Instances - Advanced: Request Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
agentName - LTI
agentName - LTI
agentName

Agent

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


N


Anchor
businessServices - LTI
businessServices - LTI
businessServices

Member of Business Services

Business Services that this task instance belongs to.

Comma-separated list.

N


Anchor
customField1 - LTI
customField1 - LTI
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.

Wildcardsare supported.

N


Anchor
customField2 - LTI
customField2 - LTI
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


Anchor
executionUser - LTI
executionUser - LTI
executionUser

Execution User

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

System-supplied.

N


Anchor
instanceNumber - LTI
instanceNumber - LTI
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


Anchor
late - LTI
late - LTI
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


Anchor
lateEarly - LTI
lateEarly - LTI
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


Anchor
name - LTI
name - LTI
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.

Note

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

N


Anchor
status - LTI
status - LTI
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


Anchor
statusDescription - LTI
statusDescription - LTI
statusDescription

Status Description

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

Wildcards are supported.

N


Anchor
sysId - LTI
sysId - LTI
sysId

n/a

sys_id used within the Controller to identify a task instance.


Y
(unless name
is specified)

name

Anchor
taskId - LTI
taskId - LTI
taskId

n/a

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


N

taskName

Anchor
taskName - LTI
taskName - LTI
taskName

n/a

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


N

taskId

Anchor
templateId - LTI
templateId - LTI
templateId

n/aID 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.NtemplateName

Anchor
templateName - LTI
templateName - LTI
templateName

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

Anchor
triggerId - LTI
triggerId - LTI
triggerId

n/a

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


N

triggerName

Anchor
triggerName - LTI
triggerName - LTI
triggerName

n/a

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


N

triggerId

Anchor
type - LTI
type - LTI
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


Anchor
updateTime - LTI
updateTime - LTI
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
titleNote

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


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


Anchor
updatedTimeType - LTI
updatedTimeType - LTI
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


Anchor
workflowDefinitionId - LTI
workflowDefinitionId - LTI
workflowDefinitionId

n/a

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


N

workflowDefinitionName

Anchor
workflowDefinitionName - LTI
workflowDefinitionName - LTI
workflowDefinitionName

n/a

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


N

workflowDefinitionId

Anchor
workflowInstanceCriteria - LTI
workflowInstanceCriteria - LTI
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
titleNote

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


N


Anchor
workflowInstanceId - LTI
workflowInstanceId - LTI
workflowInstanceId

n/a

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


N

workflowInstanceName

Anchor
workflowInstanceName - LTI
workflowInstanceName - LTI
workflowInstanceName

Workflow

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


N

workflowInstanceId


Anchor
List Task Instance Variables (Show Variables)
List Task Instance Variables (Show Variables)
List Task Instance Variables (Show Variables)

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


UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - LIST
criteria - LIST
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


Anchor
taskinstanceid - LIST
taskinstanceid - LIST
taskinstanceid

UUID

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

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor
taskinstancename - LIST
taskinstancename - LIST
taskinstancename

Instance Name

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

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor
workflowInstanceName - LIST
workflowInstanceName - LIST
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


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

XML

JSON


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




Expand
titleJSON
{
    "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
 ",
      },      "valueResolved": "client@stonebranch.com",
 {
            "nameinstanceName": "DATE_YYYY_MM_DDClient_Workflow",
            "valueinstanceId": "${_date('yyyy-MM-dd')}1540493193934840131AAC49YBBVB4BB",
            "valueResolvedinherited": "2018-10-25", false
        },
     "inherited": true  {
      }     ]
}

...

criteria

String; URI parameter. Valid values:

Default is Oldest Active Instance (1).

taskinstanceidtaskinstancenameworkflowinstancename

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - LISTcriteria - LIST

n/a

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

N

Anchor
taskinstanceid - LISTtaskinstanceid - LIST

UUID

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

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor
taskinstancename - LISTtaskinstancename - LIST

Instance Name

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

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor
workflowInstanceName - LISTworkflowInstanceName - LIST

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
 "name": "DATE_YYYY_MM_DD",
            "value": "${_date('yyyy-MM-dd')}",
            "valueResolved": "2018-10-25",
            "inherited": true
        }
    ]
}



Anchor
Release a Task Instance from Hold
Release a Task Instance from Hold
Release a Task Instance from Hold

...

Examples

XML

JSON

Example Request


Expand
titleXML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <recursive>true</recursive>
</task-instance>


or

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



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test"
}


Example Response


Expand
titleXML
<command-response>
    <type>release</type>
    <success>true</success>
    <info>Command Release executed successfully against task instance "Timer 60".</info>
    <errors />
</command-response>



Expand
titleJSON
{
  "type": "release",
  "success": true,
  "info": "Command Release executed successfully against task instance \"Task 1\".",
  "errors": ""
}


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - RTI
criteria - RTI
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
titleNote

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


N


Anchor
id - RTI
id - RTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - RTI
name - RTI
name

Instance Name

Name of the task instance


Y
(unless id
is specified)

id

Anchor
recursive - RTI
recursive - RTI
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


Anchor
workflowInstanceName - RTI
workflowInstanceName - RTI
workflowinstancenameworkflowInstanceName

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


...

Examples

XML

JSON

Example Request


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


or

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


or

<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <taskStatus>Success</taskStatus>
      <recursive>true</recursive>
</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test"
}


Example Response


Expand
titleXML
<command-response>
    <type>rerun</type>
    <success>true</success>
    <info>Command Re-run executed successfully against task instance "test".</info>
    <errors />
</command-response>



Expand
titleJSON
{
  "type": "rerun",
  "success": true,
  "info": "Command Re-run executed successfully against task instance \"Task 1\".",
  "errors": ""
}


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - RER
criteria - RER
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
titleNote

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


N


Anchor
id - RER
id - RER
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - RER
name - RER
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
recursive - RER
recursive - RER
recursive

n/a

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

Valid values: true/false. Default is false.

N


Anchor
taskStatus - RER
taskStatus - RER
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


Anchor
workflowInstanceName - RER
workflowInstanceName - RER
workflowinstancenameworkflowInstanceName

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


...


Description

URI

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

HTTP Method

GET

Description

Retrieves the output of a task instance.

Note
titleNote

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.

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - RET
criteria - RET
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
String; URI parameter. Valid values:
  • As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
numlines - RET
numlines - RET
numlines

Number of Lines

Number of lines to retrieve.

Integer

N


Anchor
outputtype - RET
outputtype - RET
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)


Anchor
scantext - RET
scantext - RET
scantext

Scan Text

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

String; URI parameter.

N


Anchor
startline - RET
startline - RET
startline

Start Line

Retrieve data beginning at the line indicated.

Integer; URI parameter. Default is 1.

N


Anchor
taskinstanceid - RET
taskinstanceid - RET
taskinstanceid

UUID

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

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor
taskinstancename - RET
taskinstancename - RET
taskinstancename

Instance Name

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

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor
workflowInstanceName - RET
workflowInstanceName - RET
workflowinstancenameworkflowInstanceName

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


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - SOM
criteria - SOM
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
titleNote

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


N


Anchor
delayDuration - SOM
delayDuration - SOM
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)


Anchor
delaySeconds - SOM
delaySeconds - SOM
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)


Anchor
delayType - SOM
delayType - SOM
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.)


Anchor
id - SOM
id - SOM
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - SOM
name - SOM
name

Instance Name

Name of the task instance


Y
(unless id
is specified)

id

Anchor
waitDayConstraint- SOM
waitDayConstraint- SOM
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


Anchor
waitDuration - SOM
waitDuration - SOM
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)


Anchor
waitTime - SOM
waitTime - SOM
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)


Anchor
waitTime - SOM
waitTime - SOM
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)


Anchor
waitType - SOM
waitType - SOM
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.)


Anchor
workflowInstanceName - SOM
workflowInstanceName - SOM
workflowinstancenameworkflowInstanceName

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


...

Examples

XML

JSON

Example Request


Expand
titleXML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <priorityType>medium</priorityType>
</task-instance>


or

<task-instance>
      <name>Timer 60</name>
      <criteria>Newest Instance</criteria>
      <workflowinstancenameworkflowInstanceName>test</workflowinstancenameworkflowInstanceName> 
      <priorityType>medium</priorityType>
</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test",
"priorityType": "High"
}


Example Response


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




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



...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - SP
criteria - SP
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
titleNote

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


N


Anchor
id - SP
id - SP
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - SP
name - SP
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
priorityType - SP
priorityType - SP
priorityType

n/a

Sets the priority for this task instance.

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

Y


Anchor
workflowInstanceName - SP
workflowInstanceName - SP
workflowinstancenameworkflowInstanceName

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


...

Examples

XML

JSON

Example Request


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


or

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



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test",
}


Example Response


Expand
titleXML
<command-response>
    <type>skip</type>
    <success>true</success>
    <info>Command Skip executed successfully against task instance "test".</info>
    <errors />
</command-response



Expand
titleJSON
{
  "type": "skip",
  "success": true,
  "info": "Command Skip executed successfully against task instance \"Task 1\".",
  "errors": ""
}


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - STI
criteria - STI
criteria

n/a

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

Valid values:

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
titleNote

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


N


Anchor
id - STI
id - STI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - STI
name - STI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - STI
workflowInstanceName - STI
workflowinstancenameworkflowInstanceName

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


...

Examples

XML

JSON

Example Request


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


or

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



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test",
}


Example Response


Expand
titleXML
<command-response>
    <type>skip</type>
    <success>true</success>
    <info>Command Skip Path executed successfully against task instance "test".</info>
    <errors />
</command-response



Expand
titleJSON
{
  "type": "skip",
  "success": true,
  "info": "Command Skip Path executed successfully against task instance \"Task 1\".",
  "errors": ""
}


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - STIP
criteria - STIP
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
titleNote

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


N


Anchor
id - STIP
id - STIP
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - STIP
name - STIP
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - STIP
workflowInstanceName - STIP
workflowinstancenameworkflowInstanceName

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


...

Examples

XML

JSON

Example Request


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


or

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



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowinstancenameworkflowInstanceName": "Test",
}


Example Response


Expand
titleXML
<command-response>
    <type>unskip</type>
    <success>true</success>
    <info>Command Unskip Path executed successfully against task instance "test".</info>
    <errors />
</command-response



Expand
titleJSON
{
  "type": "unskip",
  "success": true,
  "info": "Command Unskip executed successfully against task instance \"Task 1\".",
  "errors": ""
}


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - UTI
criteria - UTI
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
titleNote

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


N


Anchor
id - UTI
id - UTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - UTI
name - UTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - UTI
workflowInstanceName - UTI
workflowinstancenameworkflowInstanceName

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


...


UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - LIST
criteria - LIST
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


Anchor
taskinstanceid - LIST
taskinstanceid - LIST
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

Anchor
taskinstancename - LIST
taskinstancename - LIST
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

Anchor
workflowInstanceName - LIST
workflowInstanceName - LIST
workflowinstancenameworkflowInstanceName

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


...