Panel | ||||
---|---|---|---|---|
|
...
Universal Controller supports the following RESTful-based web services for Task Instance operations, which are listed alphabetically on this page.
- Cancel a Task Instance
- Clear All Dependencies
- Clear Exclusive Dependencies
- Clear Predecessor Dependencies
- Clear Time Dependency
- Clear Virtual Resource Dependencies
- Delete a Task Instance 17498168
- 17498168
- 17498168
- 17498168
- 17498168
- 17498168
- 17498168
- Force/Finish a Task Instance
- Force/Finish Cancel a Task Instance
- Hold a Task Instance
- Issue Set Completed Command for a Manual Task Instance
- Issue Set Started Command for a Manual Task Instance
- List Task Instances 17498168
- 17498168
- 17498168
- 17498168
- List Task Instances - Advanced
- List Task Instance Variables (Show Variables)
- Release a Task Instance from Hold
- Rerun a Task Instance
- Retrieve Task Instance Output
- Set or Modify Wait Time/Duration for Task Instance
- Set Priority for a Task Instance
- Skip a Task Instance
- Skip a Task Instance Path
- Unskip a Task Instance
- Update a Task Instance Operational Memo 17498168
- 17498168
- 17498168
- 17498168
- 17498168
- 17498168
- 17498168
- 17498168
- 17498168
- 17498168
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
Description | |
---|---|
URI | |
HTTP Method | POST |
Description | Cancel a task instance. |
Example URI | http://localhost:8080/uc/resources/taskinstance/cancel |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
Example Request | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
| |||||||||||
Example Response |
|
|
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
| |||||||||||
Example Response |
|
|
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
| |||||||||||
Example Response |
|
|
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
predecessorName | n/a | Name of the predecessor task instance for which you want to clear dependency. | * = Clears dependencies from all predecessor task instances. | Y | ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request | ||||||||||||
Example Response |
|
|
...
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 | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/taskinstance |
HTTP Method | DELETE |
Description | Deletes the specified task instance. For Workflow task instances, if the |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Example URI | http://localhost:8080/uc/resources/taskinstance |
Example Request | |
Request Properties | |
Example Response |
|
...
XML | JSON | |||||
---|---|---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
| |||||||||||
Example Response |
|
|
...
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 | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
| |||||||||||
Example Response |
|
|
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request | ||||||||||||
Example Response |
|
|
...
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 | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
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 | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
| ||||||||||||||||||||||||
|
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
agentName | Agent | Name of the agent that this task instances is assigned to run on. | N | |||||||||||||
businessServices | Member of Business Services | Business Services that this task instance belongs to. | Comma-separated list. | N | ||||||||||||
customField1 | Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.) | User-defined task field 1. | Wildcards are supported. | N | ||||||||||||
customField2 | Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.) | User-defined task field 2. | Wildcards are supported. | N | ||||||||||||
executionUser | Execution User | Execution User of a task instance that determines the security context under which the task instance runs. | System-supplied. | N | ||||||||||||
instanceNumber | Instance Number | Sequentially assigned number, maintained per task, representing the creation order of the instance. | Integer value. | N | ||||||||||||
late | Started Late / Finished Late | Indication of whether or not to list all task instances that started late or finished late. | Valid values: true/false. | N | ||||||||||||
lateEarly | Started Late / Finished Late / Finished Early | Indication of whether or not to list all task instances that started late, finished late, or finished early. | Valid values: true/false. | N | ||||||||||||
name | Instance name | Name or partial name of one or more task instances. | Wildcards are supported. | Y |
| |||||||||||
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. | N | ||||||||||||
statusDescription | Status Description | Description (if any) of the current status of the Task Instance. | Wildcards are supported. | N | ||||||||||||
sysId | n/a | sys_id used within the Controller to identify a task instance. | Y |
| ||||||||||||
taskId | n/a | sys_id of the task definition that this Task Instance was created from. | N |
| ||||||||||||
taskName | n/a | Name of the task definition that this Task Instance was created from. | N |
| ||||||||||||
templateId | n/a | ID used within the controller to identify a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateName | |||||||||||
templateName | Template Name | Name of a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateId | |||||||||||
triggerId | n/a | sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger). | N |
| ||||||||||||
triggerName | n/a | Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.) | N |
| ||||||||||||
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. | N | ||||||||||||
updatedTime | n/a | If | Valid values:
Default is d. If
| Y | ||||||||||||
updatedTimeType | n/a | Type of | Valid values:
| N | ||||||||||||
workflowDefinitionId | n/a | sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowDefinitionName | n/a | Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowInstanceCriteria | n/a | Specification for how | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
workflowInstanceId | n/a | sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
| ||||||||||||
workflowInstanceName | Workflow | Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
|
...
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/listadv http://host_name/uc/resources/taskinstance/listAdv |
HTTP Method | POST |
Description | List Task instance output details |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | |
Consumes Content-Type | Application/XML & Application/JSON |
Example Request | See List Task Instances - Advanced: XML and JSON Request Examples. |
Example Response | See List Task Instances - Advanced: XML and JSON Response Examples. |
Request Properties |
Anchor | ||||
---|---|---|---|---|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
agentName | Agent | Name of the agent that this task instances is assigned to run on. | N | |||||||||||||
businessServices | Member of Business Services | Business Services that this task instance belongs to. | Comma-separated list. | N | ||||||||||||
customField1 | Custom 1 (default, which you can change in the User Defined Task Field Label 1 Universal Controller system property.) | User-defined task field 1. | Wildcardsare supported. | N | ||||||||||||
customField2 | Custom 2 (default, which you can change in the User Defined Task Field Label 2 Universal Controller system property.) | User-defined task field 2. | Wildcards are supported. | N | ||||||||||||
executionUser | Execution User | Execution User of a task instance that determines the security context under which the task instance runs. | System-supplied. | N | ||||||||||||
instanceNumber | Instance Number | Sequentially assigned number, maintained per task, representing the creation order of the instance. | Integer value. | N | ||||||||||||
| Output Type | Type of task instance output to retrieve. | String; Valid values:
| N | ||||||||||||
late | Started Late / Finished Late | Indication of whether or not to list all task instances that started late or finished late. | Valid values: true/false. | N | ||||||||||||
lateEarly | Started Late / Finished Late / Finished Early | Indication of whether or not to list all task instances that started late, finished late, or finished early. | Valid values: true/false. | N | ||||||||||||
name | Instance name | Name or partial name of one or more task instances. | Wildcards are supported. | Y |
| |||||||||||
| N/A | Allowed Response fields | Comma separated list of any of the following fields can be viewed.
| N | ||||||||||||
status | Status | List of comma-separated task instance status codes and/or names (not case sensitive). | Specifying one or more statuses automatically excludes task instances in all other statuses. | N | ||||||||||||
statusDescription | Status Description | Description (if any) of the current status of the Task Instance. | Wildcards are supported. | N | ||||||||||||
sysId | n/a | sys_id used within the Controller to identify a task instance. | Y |
| ||||||||||||
taskId | n/a | sys_id of the task definition that this Task Instance was created from. | N |
| ||||||||||||
taskName | n/a | Name of the task definition that this Task Instance was created from. | N |
| ||||||||||||
templateId | n/a | ID used within the controller to identify a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateName | |||||||||||
templateName | Template Name | Name of a template. | If a templateId or templateName is specified, List task returns a list of tasks associated with the Universal template. | N | templateId | |||||||||||
triggerId | n/a | sys_id of the Trigger that launched the Task Instance (if it was invoked from a Trigger). | N |
| ||||||||||||
triggerName | n/a | Name of the Trigger that launched the Task Instance (if it was invoked from a Trigger.) | N |
| ||||||||||||
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. | N | ||||||||||||
updatedTime | n/a | If | Valid values:
Default is d. updatedTimeType is Between; date/time values (start date/time inclusive, end date/time exclusive)( yyyy-MM-dd [HH:mm:ss], yyyy-MM-dd [HH:mm:ss])
| Y | ||||||||||||
updatedTimeType | n/a | Type of | Valid values:
| N | ||||||||||||
workflowDefinitionId | n/a | sys_id of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowDefinitionName | n/a | Name of the parent workflow task definition for the Task Instance (if it was invoked from a Worklfow). | N |
| ||||||||||||
workflowInstanceCriteria | n/a | Specification for how | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
workflowInstanceId | n/a | sys_id of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
| ||||||||||||
workflowInstanceName | Workflow | Name of the parent workflow task instance. Only task instances within this workflow task instance will be listed. | N |
|
...
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 | ||||
---|---|---|---|---|
|
UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Used if | String; URI parameter. Valid values:
Default is Oldest Active Instance (1). | N | |||||||
taskinstanceid | UUID | UUID of the task instance for which you want to list variables. | String; URI parameter. | Y |
| ||||||
taskinstancename | Instance Name | Name of the task instance for which you want to list variables. | String; URI parameter. | Y |
| ||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
Description | |
---|---|
URI | http://host_name/uc/resources/taskinstance/release |
HTTP Method | POST |
Description | Releases the specified task instance from hold. |
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 | |
Example Response | See Release a Task Instance from Hold: XML and JSON Examples. |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Iinstance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance | Y |
| ||||||||||||
recursive | n/a | For Workflow task instances only; Specification for whether or not to release from hold all children task instances of the task instance. | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
recursive | n/a | Indication of whether or not tasks within sub-workflows will qualify for rerun. | Valid values: true/false. Default is false. | N | ||||||||||||
taskStatus | Status | If matched task instance is workflow type; List of comma-separated status codes or case-insensitive status names. All tasks within the matching workflow with a matching status will be queued for rerun. | Valid statuses:
| Y | ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
Description | ||||||
---|---|---|---|---|---|---|
URI | http://host_name/uc/resources/taskinstance/retrieveoutput | |||||
HTTP Method | GET | |||||
Description | Retrieves the output of a task instance.
| |||||
Example URI |
| |||||
Consumes Content-Type | n/a | |||||
Produces Content-Type | application/xml, application/json | |||||
Example URI Properties | ||||||
Example Response | See Retrieve Task Instance Output: XML and JSON Response Examples. |
Anchor | ||||
---|---|---|---|---|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Used if | String; URI parameter. Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
numlines | Number of Lines | Number of lines to retrieve. | Integer | N | ||||||||||||
outputtype | Output Type | Type of task instance output to retrieve. | String; URI parameter. Valid values:
Default is OUTERR (0). | Y | ||||||||||||
scantext | Scan Text | Scan the data for the text specified and retrieve only that. | String; URI parameter. | N | ||||||||||||
startline | Start Line | Retrieve data beginning at the line indicated. | Integer; URI parameter. Default is 1. | N | ||||||||||||
taskinstanceid | UUID | UUID of the task instance for which you want to retrieve output. | String; URI parameter. | Y |
| |||||||||||
taskinstancename | Instance Name | Name of the task instance for which you want to retrieve output. | String; URI parameter. | Y |
| |||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
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 | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
| |||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
delayDuration | Delay Duration | If | Format: DD:HH:MM:SS | Y | ||||||||||||
delaySeconds | Delay Duration In Seconds | If | Format: SS | Y | ||||||||||||
delayType | Delay On Start | Amount of time to delay the start of a task once it is eligible to start. | Valid values:
| Y | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance | Y |
| ||||||||||||
waitDayConstraint | Wait Day Constraint | If | Valid values:
| N | ||||||||||||
waitDuration | Wait Duration | If | Format: DD:HH:MM:SS | Y | ||||||||||||
waitSeconds | Wait Duration In Seconds | If | Format: SS | Y | ||||||||||||
waitTime | Wait Time | If | Format: HH:MM | Y | ||||||||||||
waitType | Wait To Start | Amount of time to wait before starting a task after it has been launched. | Valid values:
| Y | ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
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). |
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 | |
Example Response | See Set Priority for a Task Instance: XML and JSON Examples. |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
priorityType | n/a | Sets the priority for this task instance. | Valid values: low, medium, high; Case-insensitive. | Y | ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
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 | |
Request Properties | |
Example Response |
Anchor | ||||
---|---|---|---|---|
|
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Specific task instance with this task instance | Valid values:
Default is Oldest Active Instance (1).
| N | ||||||||||||
id | n/a | sys_id used within the Controller to identify this task instance. | Y |
| ||||||||||||
name | Instance Name | Name of the task instance. | Y |
| ||||||||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...
Description | |
---|---|
URI | |
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 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 | ||||
---|---|---|---|---|
|
...
UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
criteria | n/a | Used if | String; URI parameter. Valid values:
Default is Oldest Active Instance (1). | N | |||||||
taskinstanceid | UUID | UUID of the task instance for which you want to update the Operational Memo. | String; URI parameter. | Y |
| ||||||
taskinstancename | Instance Name | Name of the task instance for which you want to update the Operational Memo. | String; URI parameter. | Y |
| ||||||
workflowinstancename workflowInstanceName | Workflow | Name of the parent Workflow of the task instance. | You can select to display the Workflow field on the Activity Monitor and/or Task Instances List; it is not displayed in the Task Instance Details. | N |
...