Page Comparison

...

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

<command-response>
      <type>clear_exclusive</type>
      <success>true</success>
      <info>Command Clear Exclusive executed successfully against task instance "Timer 60".</info>
      <errors />
</command-response>

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

{
"name": "Timer 60",
"criteria": "Newest Instance",
"workflowInstanceName": "Test",
"predecessorName": "Task 1"
}

Example Response

Expand

title	XML

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

Expand

title	JSON

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

...

	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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

{
  "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 URI	http://localhost:8080/uc/resources/taskinstance/clearresources
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Clear Virtual Resource Dependencies: XML and JSON Examples.
Request Properties	See Clear Virtual Resource Dependencies: Request Properties.
Example Response	See Clear Virtual Resource Dependencies: XML and JSON Examples.

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	XML

Delete Task instance by task instance id.

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

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

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

Delete Task instance by task instance name.

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

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

<command-response>
    <type>force_finish</type>
    <success>true</success>
    <info>Command Force Finish executed successfully against task instance "test".</info>
    <errors />
</command-response>

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

...

	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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

...

	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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

...

	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

title	XML

Task instance with multiple query criteria.

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

All task instances in the last three minutes.

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

Task instance with the specified id.

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

Task instance with multiple query criteria.

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

All task instances that either started late or finished late.

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

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

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

All task instances that neither started late nor finished late.

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

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

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

Expand

title	JSON

Task instance with multiple query criteria.

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

All task instances in the last three minutes.

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

Task instance with the specified id.

{
      "sysId": "1513644026115413351LS9ACLESSKLXZ"
       
 }

Task instance with multiple query criteria.

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

All task instances that either started late or finished late.

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

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

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

All task instances that neither started late nor finished late.

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

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

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

Anchor

	List Task Instances Example Response
	List Task Instances Example Response

Example Response

Expand

title	XML

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

title	JSON

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>

...

Note

title	Note

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

...

	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	http://host_name/uc/resources/taskinstance/showvariables?taskinstancename=Complete_Order http://host_name/uc/resources/taskinstance/showvariables?taskinstancename=Complete_Order&fetchglobal=true http://host_name/uc/resources/taskinstance/showvariables?taskinstanceid=1540493193934844131JT6DW8IKYH2MM
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

...

	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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	XML

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

or

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	Note

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

Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example URI Properties

See Retrieve Task Instance Output: Example URI Properties.

Example Response

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

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

title	XML

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

{
"name": "Task 1",
"criteria": "Newest Instance",
"workflowInstanceName": "Test",
"priorityType": "High"
}

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

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

title	XML

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

or

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

Expand

title	JSON

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

Example Response

Expand

title	XML

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

Expand

title	JSON

{
  "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	http://localhost:8080/uc/resources/taskinstance/updatememo?taskinstancename=win-task-1&criteria=3 http://localhost8080/uc/resources/taskinstance/updatememo?taskinstanceid=3760d406e5b64e66b1c7117f22e570a1&criteria=2
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 Body	See Update a Task Instance Operational Memo: Text/Plain Examples.
Example Response Body	See 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

...

Version	Old Version 8	New Version Current
Changes made by	Stonebranch (Deactivated)	Stonebranch (Deactivated)
Saved on	Jul 17, 2023	Jul 17, 2023

Versions Compared

Key

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

Anchor
Clear All Dependencies XML and JSON Examples
Clear All Dependencies XML and JSON Examples
Clear All 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

Anchor
Clear Predecessor Dependencies XML and JSON Examples
Clear Predecessor Dependencies XML and JSON Examples
Clear Predecessor Dependencies: 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

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

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

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

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

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

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

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

Anchor
List Task Instances XML and JSON Examples
List Task Instances XML and JSON Examples
List Task Instances: XML and JSON 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

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

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

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

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

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

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

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

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

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

Page Comparison

Versions Compared

Key

AnchorCancel a Task Instance XML and JSON ExamplesCancel a Task Instance XML and JSON ExamplesCancel a Task Instance: XML and JSON Examples

AnchorClear All Dependencies XML and JSON ExamplesClear All Dependencies XML and JSON ExamplesClear All Dependencies: XML and JSON Examples

AnchorClear Exclusive Dependencies XML and JSON ExamplesClear Exclusive Dependencies XML and JSON ExamplesClear Exclusive Dependencies: XML and JSON Examples

AnchorClear Predecessor Dependencies XML and JSON ExamplesClear Predecessor Dependencies XML and JSON ExamplesClear Predecessor Dependencies: XML and JSON Examples

AnchorClear Time Dependency XML and JSON ExamplesClear Time Dependency XML and JSON ExamplesClear Time Dependency: XML and JSON Examples

AnchorClear Virtual Resource Dependencies XML and JSON ExamplesClear Virtual Resource Dependencies XML and JSON ExamplesClear Virtual Resource Dependencies: XML and JSON Examples

AnchorDelete a Task Instance Request PropertiesDelete a Task Instance Request PropertiesDelete a Task Instance: Request Properties

AnchorForce Finish a Task Instance XML and JSON ExamplesForce Finish a Task Instance XML and JSON ExamplesForce Finish a Task Instance: XML and JSON Examples

AnchorForce Finish Cancel a Task Instance XML and JSON ExamplesForce Finish Cancel a Task Instance XML and JSON ExamplesForce Finish/Cancel a Task Instance: XML and JSON Examples

AnchorHold a Task Instance XML and JSON ExamplesHold a Task Instance XML and JSON ExamplesHold a Task Instance: XML and JSON Examples

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

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

AnchorList Task Instances XML and JSON ExamplesList Task Instances XML and JSON ExamplesList Task Instances: XML and JSON Examples

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

AnchorRelease a Task Instance from Hold XML and JSON ExamplesRelease a Task Instance from Hold XML and JSON ExamplesRelease a Task Instance from Hold: XML and JSON Examples

AnchorRerun a Task Instance XML and JSON ExamplesRerun a Task Instance XML and JSON ExamplesRerun a Task Instance: XML and JSON Examples

AnchorRetrieve Task Instance Output XML and JSON Response ExamplesRetrieve Task Instance Output XML and JSON Response ExamplesRetrieve Task Instance Output: XML and JSON Response Examples

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

AnchorSet Priority for a Task Instance XML and JSON ExamplesSet Priority for a Task Instance XML and JSON ExamplesSet Priority for a Task Instance: XML and JSON Examples

AnchorSkip a Task Instance XML and JSON ExamplesSkip a Task Instance XML and JSON ExamplesSkip a Task Instance: XML and JSON Examples

AnchorSkip a Task Instance Path XML and JSON ExamplesSkip a Task Instance Path XML and JSON ExamplesSkip a Task Instance Path: XML and JSON Examples

AnchorUnskip a Task Instance XML and JSON ExamplesUnskip a Task Instance XML and JSON ExamplesUnskip a Task Instance: XML and JSON Examples

AnchorUpdate a Task Instance Operational Memo Text-Plain ExamplesUpdate a Task Instance Operational Memo Text-Plain ExamplesUpdate a Task Instance Operational Memo: Text/Plain 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

Anchor
Clear All Dependencies XML and JSON Examples
Clear All Dependencies XML and JSON Examples
Clear All 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

Anchor
Clear Predecessor Dependencies XML and JSON Examples
Clear Predecessor Dependencies XML and JSON Examples
Clear Predecessor Dependencies: 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

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

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

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

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

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

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

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

Anchor
List Task Instances XML and JSON Examples
List Task Instances XML and JSON Examples
List Task Instances: XML and JSON 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

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

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

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

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

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

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

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

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

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