Versions Compared

Old Version 7

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 8

changes.mady.by.user Stonebranch

Saved on

Key

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

...

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.

...


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


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


...


Description

URI

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

HTTP Method

POST

Description

Clears all dependencies of a task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear All Dependencies: XML and JSON Examples.

Request Properties

See Clear All Dependencies: Request Properties.

Example Response

See Clear All Dependencies: XML and JSON Examples.

Anchor
Clear All Dependencies XML and JSON Examples
Clear All Dependencies XML and JSON Examples
Clear All Dependencies: XML and JSON Examples

Examples

XML

JSON

Example Request


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

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



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



Example Response


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



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


...


Description

URI

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

HTTP Method

POST

Description

Clears all exclusive dependencies of a task instance.

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Exclusive Dependencies: XML and JSON Examples.

Request Properties

See Clear Exclusive Dependencies: Request Properties.

Example Response

See Clear Exclusive Dependencies: XML and JSON Examples.

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>
</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</type>
      <success>true</success>
      <info>Command Clear Exclusive executed successfully against task instance "Timer 60".</info>
      <errors />
</command-response>



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


...


Description

URI

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

HTTP Method

POST

Description

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

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Predecessor Dependencies: XML and JSON Examples.

Request Properties

See Clear Predecessor Dependencies: Request Properties.

Example Response

See Clear Predecessor Dependencies: XML and JSON Examples.

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>Timer 60</name>
      <criteria>Newest Instance</criteria>
      <workflowinstancenameworkflowInstanceName>test</workflowinstancenameworkflowInstanceName> 
      <predecessorName>*</predecessorName>
</task-instance>



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


Example Response


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



Expand
titleJSON
{
  "type": "set_edge_satisfied",
  "success": true,
  "info": "Successfully marked the dependency as satisfied.",
  "errors": ""
}


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - CPD
criteria - CPD
criteria

n/a

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

Valid values:


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

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
id - CPD
id - CPD
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - CPD
name - CPD
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
predecessorName - CPD
predecessorName - CPD
predecessorName

n/a

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

* = Clears dependencies from all predecessor task instances.

Y


Anchor
workflowInstanceName - CPD
workflowInstanceName - CPD
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


Description

URI

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

HTTP Method

POST

Description

Clears the time dependency of a task instance.

Authentication

HTTP Basic

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Time Dependency: XML and JSON Examples.

Request Properties

See Clear Time Dependency : Request Properties.

Example Response

See Clear Time Dependency: XML and JSON Examples.

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


or

<task-instance>
      <name>Test task</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>clear_timewait</type>
      <success>true</success>
      <info>Command Clear Time Wait/Delay executed successfully against task instance "Test task".</info>
      <errors />
</command-response>



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


...


Description

URI

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

HTTP Method

POST

Description

Clears virtual resource dependencies of a task instance.

Authentication

HTTP Basic

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Clear Virtual Resource Dependencies: XML and JSON Examples.

Request Properties

See Clear Virtual Resource Dependencies: Request Properties.

Example Response

See Clear Virtual Resource Dependencies: XML and JSON Examples.

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
<task-instance>
      <id>1464817327170011848D633V6106ENQ7</id>
      <resourceName>V1</resourceName>
</task-instance>


or

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



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


Example Response


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



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


...


Description

URI

http://host_name/uc/resources/taskinstance

HTTP Method

DELETE

Description

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Example URI

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

Example Request

See Delete a Task Instance: XML and JSON Examples.

Request Properties

See Delete a Task Instance: Request Properties.

Example Response

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

...

XML

JSON


Expand
titleXML

Delete Task instance by task instance id.


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


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


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


 
 
Delete Task instance by task instance name.


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



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


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

...


Description

URI

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

HTTP Method

POST

Description

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

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

See Force Finish a Task Instance: Request Properties.

Example Response

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

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


...


Description

URI

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

HTTP Method

POST

Description

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

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

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

Example Response

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

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


...


Description

URI

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

HTTP Method

POST

Description

Hold a task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Hold a Task Instance: XML and JSON Examples.

Request Properties

See Hold a Task Instance: Request Properties.

Example Response

See Hold a Task Instance: XML and JSON Examples.

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>410d6c0bc0a801c901838d8ac43b3279</id>
</task-instance>


or

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



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


Example Response


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



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


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - HTI
criteria - HTI
criteria

n/a

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

Valid values:


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

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
id - HTI
id - HTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - HTI
name - HTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - HTI
workflowInstanceName - HTI
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


Description

URI

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

HTTP Method

POST

Description

Issues a Set Completed command for a Manual Task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

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

Example Response

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

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

Examples

XML

JSON

Example Request


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


or

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



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


Example Response


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



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


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - ISCC
criteria - ISCC
criteria

n/a

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

Valid values:

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

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
id - ISCC
id - ISCC
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - ISCC
name - ISCC
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - ISCC
workflowInstanceName - ISCC
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


Description

URI

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

HTTP Method

POST

Description

Issues a Set Started command for a Manual Task instance.

Example URI

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

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

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

Request Properties

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

Example Response

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

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

Examples

XML

JSON

Example Request


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


or

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



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


Example Response


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



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


...

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
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


Description

URI

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

Examples

XML

JSON

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


Expand
titleXML

Task instance with multiple query criteria.


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


 
 
All task instances in the last three minutes.


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


 
 
Task instance with the specified id.


<task-instance-query-filter>
      <sysId>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>



Expand
titleJSON

Task instance with multiple query criteria.


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


 
All task instances in the last three minutes.


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


 
Task instance with the specified id.


{
      "sysId": "1513644026115413351LS9ACLESSKLXZ"
       
 }


 
Task instance with multiple query criteria.


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


 
All task instances that either started late or finished late.


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


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


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


 
All task instances that neither started late nor finished late.


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


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


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


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


Expand
titleXML


Panel


Html bobswift
<pre>
&lt;taskInstance&gt;
  &lt;agent /&gt;
  &lt;credentials /&gt;
  &lt;customField1 label="Custom 1"&gt;My Custom Field #1&lt;/customField1&gt;
  &lt;customField2 label="Custom 2"&gt;My Other Custom Field #2&lt;/customField2&gt;
  &lt;earlyFinish&gt;false&lt;/earlyFinish&gt;
  &lt;endTime&gt;&lt;/endTime&gt;
  &lt;executionUser&gt;ops.admin&lt;/executionUser&gt;
  &lt;exitCode&gt;0&lt;/exitCode&gt;
  &lt;finishedEarly&gt;false&lt;/finishedEarly&gt;
  &lt;finishedLate&gt;false&lt;/finishedLate&gt;
  &lt;instanceNumber&gt;6&lt;/instanceNumber&gt;
  &lt;lateFinish&gt;false&lt;/lateFinish&gt;
  &lt;lateStart&gt;false&lt;/lateStart&gt;
  &lt;launchTime&gt;2019-06-27 11:18:41 -0400&lt;/launchTime&gt;
  &lt;name&gt;B-06884 - Timer - END - 15616456627821537077YBESF7H0KELV&lt;/name&gt;
  &lt;queuedTime&gt;&lt;/queuedTime&gt;
  &lt;startTime&gt;2019-06-27 11:18:41 -0400&lt;/startTime&gt;
  &lt;startedLate&gt;false&lt;/startedLate&gt;
  &lt;status&gt;RUNNING&lt;/status&gt;
  &lt;statusDescription /&gt;
  &lt;sysId&gt;15616456627821537077YBESF7H0KELV&lt;/sysId&gt;
  &lt;taskId&gt;05564cd1f6c4484997cfb66782feb0d0&lt;/taskId&gt;
  &lt;taskName&gt;B-06884 - Timer - END - ${B_08477_WKFLW_ID}&lt;/taskName&gt;
  &lt;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}",
  "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>




...

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


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

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

...

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.

...


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) XML and JSON Response Examples
List Task Instance Variables (Show Variables) XML and JSON Response Examples
List Task Instance Variables (Show Variables): XML and JSON Response Examples

...


UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - LIST
criteria - LIST
criteria

n/a

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

String; URI parameter. Valid values:

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

Default is Oldest Active Instance (1).

N


Anchor
taskinstanceid - LIST
taskinstanceid - LIST
taskinstanceid

UUID

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

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor
taskinstancename - LIST
taskinstancename - LIST
taskinstancename

Instance Name

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

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor
workflowInstanceName - LIST
workflowInstanceName - LIST
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


Description

URI

http://host_name/uc/resources/taskinstance/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>
      <workflowinstancenameworkflowInstanceName>test</workflowinstancenameworkflowInstanceName> 
</task-instance>



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


Example Response


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



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


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - RTI
criteria - RTI
criteria

n/a

Specific task instance with this task instance name which
you want to release from hold.

Valid values:

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

Default is Oldest Active Iinstance (1).
 


Note
titleNote

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


N


Anchor
id - RTI
id - RTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - RTI
name - RTI
name

Instance Name

Name of the task instance


Y
(unless id
is specified)

id

Anchor
recursive - RTI
recursive - RTI
recursive

n/a

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

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

N


Anchor
workflowInstanceName - RTI
workflowInstanceName - RTI
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


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


or

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



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


Example Response


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



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


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - RER
criteria - RER
criteria

n/a

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

Valid values:

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

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
id - RER
id - RER
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - RER
name - RER
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
recursive - RER
recursive - RER
recursive

n/a

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

Valid values: true/false. Default is false.

N


Anchor
taskStatus - RER
taskStatus - RER
taskStatus

Status

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

Valid statuses:

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

Y


Anchor
workflowInstanceName - RER
workflowInstanceName - RER
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


Description

URI

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

HTTP Method

GET

Description

Retrieves the output of a task instance.

Note
titleNote

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


Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example URI Properties

See Retrieve Task Instance Output: Example URI Properties.

Example Response

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

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

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - RET
criteria - RET
criteria

n/a

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

String; URI parameter. Valid values:

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

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
numlines - RET
numlines - RET
numlines

Number of Lines

Number of lines to retrieve.

Integer

N


Anchor
outputtype - RET
outputtype - RET
outputtype

Output Type

Type of task instance output to retrieve.

String; URI parameter. Valid values:

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

Default is OUTERR (0).

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


Anchor
scantext - RET
scantext - RET
scantext

Scan Text

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

String; URI parameter.

N


Anchor
startline - RET
startline - RET
startline

Start Line

Retrieve data beginning at the line indicated.

Integer; URI parameter. Default is 1.

N


Anchor
taskinstanceid - RET
taskinstanceid - RET
taskinstanceid

UUID

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

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor
taskinstancename - RET
taskinstancename - RET
taskinstancename

Instance Name

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

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor
workflowInstanceName - RET
workflowInstanceName - RET
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


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


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - SOM
criteria - SOM
criteria

n/a

Specific task instance with this task instance name which
you want to release from hold.

Valid values:

  • As String = Oldest Active Instance, As Value = 1


  • As String = Newest Active Instance, As Value = 2


  • As String = Oldest Instance, As Value = 3


  • As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
delayDuration - SOM
delayDuration - SOM
delayDuration

Delay Duration

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

Format: DD:HH:MM:SS

Y
(if delayType
is duration)


Anchor
delaySeconds - SOM
delaySeconds - SOM
delaySeconds

Delay Duration In Seconds

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

Format: SS

Y
(if delayType
is seconds)


Anchor
delayType - SOM
delayType - SOM
delayType

Delay On Start

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

Valid values:

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

Y
(unless waitType
is specified.)


Anchor
id - SOM
id - SOM
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - SOM
name - SOM
name

Instance Name

Name of the task instance


Y
(unless id
is specified)

id

Anchor
waitDayConstraint- SOM
waitDayConstraint- SOM
waitDayConstraint

Wait Day Constraint

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

Valid values:

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

N


Anchor
waitDuration - SOM
waitDuration - SOM
waitDuration

Wait Duration

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

Format: DD:HH:MM:SS

Y
(if {{waitType
is duration)


Anchor
waitTime - SOM
waitTime - SOM
waitSeconds

Wait Duration In Seconds

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

Format: SS

Y
(if waitType
is seconds)


Anchor
waitTime - SOM
waitTime - SOM
waitTime

Wait Time

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

Format: HH:MM

Y
(if waitType
is time or
relative time)


Anchor
waitType - SOM
waitType - SOM
waitType

Wait To Start

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

Valid values:

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

Y
(unless delayType
is specified.)


Anchor
workflowInstanceName - SOM
workflowInstanceName - SOM
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


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>
      <workflowinstancenameworkflowInstanceName>test</workflowinstancenameworkflowInstanceName> 
      <priorityType>medium</priorityType>
</task-instance>



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


Example Response


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




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



...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - SP
criteria - SP
criteria

n/a

Specific task instance with this task instance name that you want to set a priority for.

Valid values:

  • As String = Oldest Active Instance, As Value = 1


  • As String = Newest Active Instance, As Value = 2


  • As String = Oldest Instance, As Value = 3


  • As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
id - SP
id - SP
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - SP
name - SP
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
priorityType - SP
priorityType - SP
priorityType

n/a

Sets the priority for this task instance.

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

Y


Anchor
workflowInstanceName - SP
workflowInstanceName - SP
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


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



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


Example Response


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



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


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - STI
criteria - STI
criteria

n/a

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

Valid values:

  • As String = Oldest Active Instance, As Value = 1


  • As String = Newest Active Instance, As Value = 2


  • As String = Oldest Instance, As Value = 3


  • As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
id - STI
id - STI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - STI
name - STI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - STI
workflowInstanceName - STI
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


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



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


Example Response


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



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


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - STIP
criteria - STIP
criteria

n/a

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

Valid values:

  • As String = Oldest Active Instance, As Value = 1


  • As String = Newest Active Instance, As Value = 2


  • As String = Oldest Instance, As Value = 3


  • As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
id - STIP
id - STIP
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - STIP
name - STIP
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - STIP
workflowInstanceName - STIP
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


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



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


Example Response


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



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


...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - UTI
criteria - UTI
criteria

n/a

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

Valid values:

  • As String = Oldest Active Instance, As Value = 1


  • As String = Newest Active Instance, As Value = 2


  • As String = Oldest Instance, As Value = 3


  • As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).
 


Note
titleNote

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


N


Anchor
id - UTI
id - UTI
id

n/a

sys_id used within the Controller to identify this task instance.


Y
(unless name
is specified)

name

Anchor
name - UTI
name - UTI
name

Instance Name

Name of the task instance.


Y
(unless id
is specified)

id

Anchor
workflowInstanceName - UTI
workflowInstanceName - UTI
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...


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 

...


UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
criteria - LIST
criteria - LIST
criteria

n/a

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

String; URI parameter. Valid values:

  • As String = Oldest Active Instance, As Value = 1


  • As String = Newest Active Instance, As Value = 2


  • As String = Oldest Instance, As Value = 3


  • As String = Newest Instance, As Value = 4


Default is Oldest Active Instance (1).

N


Anchor
taskinstanceid - LIST
taskinstanceid - LIST
taskinstanceid

UUID

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

String; URI parameter.

Y
(unless taskinstancename
is specified.)

taskinstancename

Anchor
taskinstancename - LIST
taskinstancename - LIST
taskinstancename

Instance Name

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

String; URI parameter.

Y
(unless taskinstanceid
is specified.)

taskinstanceid

Anchor
workflowInstanceName - LIST
workflowInstanceName - LIST
workflowinstancenameworkflowInstanceName

Workflow

Name of the parent Workflow of the task instance.

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

N


...