Versions Compared

Old Version 37

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 38

changes.mady.by.user Stonebranch

Saved on

Key

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


Panel
Table of Contents
maxlevel1

...

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

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

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

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://host_name/uc/resources/taskinstance/cancel

...

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:

  • 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

...

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

...

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://host_name/uc/resources/taskinstance/cancel

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


{
  "typename": "clear_all_dependenciesTimer 60",
 
"successcriteria": true,
  ""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 Clear All DependenciesCancel 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_exclusive<all_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 ExclusiveAll Dependencies 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:

  • 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 - 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>
      <workflowInstanceName>test</workflowInstanceName> 
  
   <predecessorName>*</predecessorName>
</task-instance>



Expand
titleJSON
{
"name": "Timer 60",
"criteria": "Newest Instance",
"workflowInstanceName": "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:

  • 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 - 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 workflowInstanceName - CPDCEDpredecessorName
workflowInstanceName - CPDCED
predecessorNameworkflowInstanceName

n/aWorkflow

Name of the parent Workflow of the predecessor task instance for which you want to clear dependency.* = Clears dependencies from all predecessor task instances.

Y

Anchor
workflowInstanceName - CPDworkflowInstanceName - CPD

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 TimePredecessors Wait/Delay 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 - CPDworkflowInstanceName
- CTDpredecessorName - 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 - CPD
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 ResourcesTime Wait/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 - CVRresourceName - 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 - CTD
workflowInstanceName - 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


Expand
titleXML

Delete Task instance by task instance id.

<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</recursivecriteria>Newest Instance</criteria>
</task-instance>

 
 
Delete Task instance by task instance name.

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



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

...

criteria

Example Response


Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - DTIcriteria - DTI


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 delete.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 (31).
 

Note
titleNote

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


N


Anchor
id - DTICVR
id - DTICVR
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

Authentication

HTTP Basic

Consumes ContentFor 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

XML

JSON

Example Request


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</workflowInstanceName> criteria>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": ""
}

...


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 - FFDTI
criteria - FFDTI
criteria

n/a

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

Valid values:

As String = Oldest Active Instance, As Value = 1

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

Default is Oldest Active Instance (13).
 

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

DetailsBoolean; 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>
      <workflowInstanceName>test</workflowInstanceName> 
</task-instance>



Expand
titleJSON
{
"name": "Task 1",
"halt": "True",
"criteria": "Newest Instance",
"workflowInstanceName": "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
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

...

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



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "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
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
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>
      <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<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
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

...

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 Basic

Issues 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
workflowInstanceName>test</workflowInstanceName>
<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> 
</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>
<name>*</name> <updatedTimeType>Offset</updatedTimeType>
<info>Command Set Started executed successfully against task instance "test".</info>
    <errors
<updatedTime>-3mn<
/
updatedTime
>
</
task-instance-query-filter>

 
 
Task instance with the specified id.

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

 
 
Task instance with multiple query criteria.

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

 
All task instances that either started late or finished late.

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

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

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

 
All task instances that neither started late nor finished late.

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

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

<task-instance-query-filter>
      <name>*</name>
      <lateEarly>false</lateEarly>
</task-instance-query-filter>
Task instance with the specified template name.
  
  <task-instance-query-filter>
        <name>*</name>
        <templateName>Demo_Ext_1</templateName>
  </task-instance-query-filter> 

Task instance with updated time type: between.

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

 
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"
       
 }
 
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": "*",
<name>B-06884*</name>
"status": "200",
<status>!45</status>
"type": "windows",
<customField1>My*</customField1>
"agentName": "Mark-4 - AGNT0002",
<customField2>*Custom*</customField2>
      <workflowDefinitionId>36551ed5663042c2b79975ad6a23915e</workflowDefinitionId>
"lateStart":
true,
   <taskName>B-06884 - Timer -
"lateFinish": false, "earlyFinish": false } 
END - ${B_08477_WKFLW_ID}</taskName>
</task-instance-query-filter>


 
 
All task instances

that either started late or finished late.{

in the last three minutes.


<task-instance-query-filter>
"name": "*",
<name>*</name>
      <updatedTimeType>Offset</updatedTimeType>
"late":
true
}
  <updatedTime>-3mn</updatedTime>
</task-instance-query-filter>


 
 

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

Task instance with the specified id.


<task-instance-query-filter>
"name": "*", 
<sysId>1448396297341015141TB2QF51JBYM8V</sysId>
</task-instance-query-filter>


 
 
Task instance with multiple query criteria.


<task-instance-query-filter>
"lateEarly": true } 
 <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

neither

either started late

nor

or finished late.


<task-instance-query-filter>
{
"name": "*",
<name>*</name>
"late": false } 
<late>true</late>
</task-instance-query-filter>


 
All task instances that

neither

either started late, finished late,

nor

or finished early.

{


<task-instance-query-filter>
"name": "*",
<name>*</name>
"lateEarly": false } 
<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>*</name>
     
  "templateName": Demo
  <templateName>Demo_Ext_
1
1</templateName>
 
}
 </task-instance-query-filter> 


Task instance with updated time type: between.

{

"name": "*",

"type": "Timer",

"updatedTimeType": "between",

"updatedTime": "2022

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

0400"

}

Anchor
List Task Instances Example ResponseList Task Instances Example Response

0400</updatedTime>
</task-instance-query-filter>


 


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
JSON

Task instance with multiple query criteria.


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


 
All task instances in the last three minutes.


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


 
Task instance with the specified id.


{
      "sysId": "1513644026115413351LS9ACLESSKLXZ"
       
 }


 
Task instance with multiple query criteria.


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


 
All task instances that either started late or finished late.


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


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


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


 
All task instances that neither started late nor finished late.


 {
      "name": "*",
      "
value
late": false
"My
Custom
}
Field
#1"
},

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

{
  
"customField2": {

    
 
"
label
name": "
Custom 2
*",
      "
value
lateEarly": 
"My
false

Other
 
Custom
} 
Field
 
#2"
  
 },
  "earlyFinish




Task instance with the specified template name.
  
{
        "name": "
false
*"
,

        "
endTime
templateName": 
"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": "
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",
  "triggeredBy": "Workflow: &lt;/launchTime&gt;
  &lt;name&gt;B-06884 - Timer Main ${ops_task_ref_count}",
  "type": "Timer",
  "updatedTime": "- END - 15616456627821537077YBESF7H0KELV&lt;/name&gt;
  &lt;queuedTime&gt;&lt;/queuedTime&gt;
  &lt;startTime&gt;2019-06-27 11:2018:1141 -0400",
  "workflowDefinitionId": "36551ed5663042c2b79975ad6a23915e",
  "workflowDefinitionName": "&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 - MainTimer - END - ${opsB_task08477_refWKFLW_count}",
  "workflowInstanceId": "15616456627821077078N9HWVH7SLHVT",
  "workflowInstanceName": "B-06884 - Main 3"
}
</pre>

...

Property

...

UI Field Name

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

Agent

...

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

...

N

...

Member of Business Services

...

Business Services that this task instance belongs to.

...

Comma-separated list.

...

N

...

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

...

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

...

Execution User

...

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

...

System-supplied.

...

N

...

Instance Number

...

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

...

Integer value.

...

N

...

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

...

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

...

Instance name

...

Name or partial name of one or more task instances.

...

Wildcards are supported.

...

Y
(unless sysId
is specified)

...

sysId

...

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

...

Status Description

...

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

...

Wildcards are supported.

...

N

...

n/a

...

sys_id used within the Controller to identify a task instance.

...

Y
(unless name
is specified)

...

name

...

n/a

...

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

...

N

...

taskName

...

n/a

...

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

...

N

...

taskId

...

n/a

...

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

...

N

...

triggerName

...

n/a

...

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

...

N

...

triggerId

...

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

...

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

...

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

...

n/a

...

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

...

N

...

workflowDefinitionName

...

n/a

...

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

...

N

...

workflowDefinitionId

...

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

...

n/a

...

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

...

N

...

workflowInstanceName

...

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.

...

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

...

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

...


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 (Show Variables): Example URI Properties.

Example Response

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

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

...


Description

URI

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

HTTP Method

POST

Description

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

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

See Release a Task Instance from Hold: Request Properties

Example Response

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

Anchor
Release a Task Instance from Hold XML and JSON Examples
Release a Task Instance from Hold XML and JSON Examples
Release a Task Instance from Hold: XML and JSON Examples

Examples

XML

JSON

Example Request


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


or

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



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "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": ""
}


...


Description

URI

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

HTTP Method

POST

Description

Rerun a task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Rerun a Task Instance: XML and JSON Examples.

Request Properties

See Rerun a Task Instance: Request Properties.

Example Response

See Rerun a Task Instance: XML and JSON Examples.

Anchor
Rerun a Task Instance XML and JSON Examples
Rerun a Task Instance XML and JSON Examples
Rerun 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>


or

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



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "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": ""
}


...


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.

Anchor
Retrieve Task Instance Output XML and JSON Response Examples
Retrieve Task Instance Output XML and JSON Response Examples
Retrieve Task Instance Output: XML and JSON Response Examples

...


Description

URI

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

HTTP Method

POST

Description

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

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

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

Example Response

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

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

Examples

XML

JSON

Example Request


Expand
titleXML
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <waitType>time</waitType>
      <waitTime>00:33</waitTime>
      <delayType>duration</delayType>
      <delayDuration>00:00:00:33</delayDuration>
</task-instance>



Expand
titleJSON
{
"id": "15137106032955949535QDWAW9IA700W",
"waitType": "Time",
"waitTime": "00:33",
"delayType": "duration",
"delayDuration": "00:00:00:33"
}


Example Response


Expand
titleXML
<command-response>
    <type>set_timewait</type>
    <success>true</success>
    <info>Successfully set timewait for task instance "test task".</info>
    <errors />
</command-response>



Expand
titleJSON
{
  "type": "set_timewait",
  "success": true,
  "info": "Successfully set timewait for task instance \"Task 1\".",
  "errors": ""
}


...


Description

URI

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

HTTP Method

POST

Description

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

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

See Set Priority for a Task Instance: Request Properties.

Example Response

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

Anchor
Set Priority for a Task Instance XML and JSON Examples
Set Priority for a Task Instance XML and JSON Examples
Set Priority for a Task Instance: XML and JSON Examples

Examples

XML

JSON

Example Request


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


or

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



Expand
titleJSON
{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "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": ""
}



...


Description

URI

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

HTTP Method

POST

Description

Skip a task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Skip a Task Instance: XML and JSON Examples.

Request Properties

See Skip a Task Instance: Request Properties.

Example Response

See Skip a Task Instance: XML and JSON Examples.

Anchor
Skip a Task Instance XML and JSON Examples
Skip a Task Instance XML and JSON Examples
Skip 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": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "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": ""
}


...


Description

URI

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

HTTP Method

POST

Description

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

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

See Skip a Task Instance Path: Request Properties.

Example Response

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

Anchor
Skip a Task Instance Path XML and JSON Examples
Skip a Task Instance Path XML and JSON Examples
Skip a Task Instance Path: 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": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "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": ""
}


...


Description

URI

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

HTTP Method

POST

Description

Unskip a task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Unskip a Task Instance: XML and JSON Examples.

Request Properties

See Unskip a Task Instance: Request Properties.

Example Response

See Unskip a Task Instance: XML and JSON Examples.

Anchor
Unskip a Task Instance XML and JSON Examples
Unskip a Task Instance XML and JSON Examples
Unskip 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": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "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": ""
}


...


Description

URI

http://host_name/uc/resources/taskinstance/updatememo

HTTP Method

PUT

Description

Update the operational memo for a task instance record.

Example URI

Authentication

HTTP Basic

Consumes Content-Type

text/plain

Produces Content-Type

text/plain

Example URI Properties

See Update a Task Instance Operational Memo: Example URI Properties.

Example Request BodySee Update a Task Instance Operational Memo: Text/Plain Examples.
Example Response BodySee Update a Task Instance Operational Memo: Text/Plain Examples.

Anchor
Update a Task Instance Operational Memo Text-Plain Examples
Update a Task Instance Operational Memo Text-Plain Examples
Update a Task Instance Operational Memo: Text/Plain Examples 

...