Task Web Services
Overview
Universal Controller supports the following RESTful-based web services for Task operations.
Formatting specifications for each web service, including details about parameter requirements, are provided.
Common Web Services
The following web services are common to all Task types:
- Task Web Services#Delete a Task
- Task Web Services#Launch a Task
- Task Web Services#List All Workflows That a Task Belongs To
- Task Web Services#List Tasks
- Task Web Services#List Tasks - Advanced
Detailed information for each of these web services is provided on this page.
Task-Specific Web Services
The following web services are specific for each Task type:
- Create a Task
- Modify a Task
- Read a Task
For detail information about these task-specific web services, see:
- Application Control Task Web Services
- Email Task Web Services
- Email Monitor Task Web Services
- Agent File Monitor Task Web Services
- File Transfer Task Web Services
- Recurring Task Web Services
- Remote File Monitor Task Web Services
- Linux Unix Task Web Services
- Manual Task Web Services
- PeopleSoft Task Web Services
- Recurring Task Web Services
- SAP Task Web Services
- SQL Task Web Services
- Stored Procedure Task Web Services
- System Monitor Task Web Services
- Task Monitor Task Web Services
- Timer Task Web Services
- Universal Command Task Web Services
- Universal Monitor Task Web Services
- Universal Task Web Services
- Variable Monitor Task Web Services
- Web Service Task Web Services
- Windows Task Web Services
- Workflow Task Web Services
- z/OS Task Web Services
Delete a Task
Description | |
---|---|
URI | http://host_name/uc/resources/task |
HTTP Method | DELETE |
Description | Deletes the specified task. |
URI Parameters | See Delete a Task: URI Parameters, below. |
Example URI | |
Authentication | HTTP Basic |
Example Response |
|
Delete a Task: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this task. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this task. | String; URI parameter. | Y |
|
Launch a Task
Description | |
---|---|
URI | http://host_name/uc/resources/task/ops-task-launch |
HTTP Method | POST |
Description | Launches the specified task. |
Example URI | http://localhost:8080/uc/resources/task/ops-task-launch |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
Example Request | |
Example Request for Task-Related Records | |
Request Properties | |
Request Task-Related Records Properties | |
Example Response |
Launch a Task: XML and JSON Examples
Examples | XML | JSON |
---|---|---|
Example Request for Task | ||
Example Request for Task-Related Records | ||
Example Response |
Launch a Task: Request Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Hold on Start | Indicates that when the task is launched, it appears in the Activity Monitor with a status of Held. The task runs when the user releases it. | Valid values = Yes,Y,true | N |
| Hold Reason | Information about why the task will be put on hold when it starts. | N | |
launchReason | Launch Reason | Reason for the task launch | N (Y if | |
| Task Name | Name of the task. | Y | |
| Time Zone | Time Zone in the which the task is launched. | N | |
| Virtual Resource Priority | Priority for acquiring a resource when two or more tasks are waiting for the resource; applies to all resources required by the task. | Integer; Valid values: 1 (high) to 20 (low). Default is 10. | N |
Task-Related Records Properties: Variables
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Name | Name of the variable. | Y | |
| Value | Value of the variable. | Y |
Task-Related Records Properties: Virtual Resources
The virtual resource dependencies specified in virtual-resources
are merged with the default virtual resource dependencies:
- If a default virtual resource dependency already exists for a specified virtual resource amount, the virtual resource dependency is updated.
- Any virtual resource specified with an amount of 0 is dropped from the default virtual resource dependencies; if the virtual resource did not exist as a default dependency, the command will fail.
- If a default virtual resource dependency does not already exist for a specified virtual resource amount, the virtual resource dependency is added. |
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Resource Description | Description of the virtual resource. | N | |
| Resource Name | Name of the virtual resource. | Y | |
| Resource Limit | Maximum number of units for this resource. | Y |
List All Workflows That a Task Belongs To
Description | |
---|---|
URI | http://host_name/uc/resources/task/parent/list |
HTTP Method | GET |
Description | Retrieves a list of parent workflows that a task belongs to. |
URI Parameters | See List All Workflows That a Task Belongs To: URI Parameters, below. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List All Workflows That a Task Belongs To: XML and JSON Examples. |
Response Properties | See List All Workflows That a Task Belongs To: Response Properties. |
List All Workflows That a Task Belongs To: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this task. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this task. | String; URI parameter. | Y |
|
List All Workflows That a Task Belongs To: XML and JSON Examples
Examples | XML | JSON |
---|---|---|
Example Response |
List All Workflows That a Task Belongs To: Response Properties
Property | UI Field Name | Description |
---|---|---|
| Task Description | User-defined description of this workflow. |
| Task Name | Name of this workflow. |
| UUID | sys_id used within the Controller to identify this workflow. |
| Version | Version number of this workflow. |
| n/a | Vertex ID of the task within this workflow. |
| n/a | Name (or alias) of the task within this workflow. |
List Tasks
Description | |
---|---|
URI | http://host_name/uc/resources/task/list |
HTTP Method | POST |
Description | Retrieves information on tasks matching specific search criteria. |
Example URI | http://localhost:8080/uc/resources/task/list |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
Example Request | |
Request Properties | |
Example Response |
List Tasks: XML and JSON Examples
Examples | XML | JSON |
---|---|---|
Example Request | ||
Example Response |
List Tasks: Request Properties
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| Agent | Agent on which this task was run. | N | ||
| Member of Business Services | Business Services that this task belongs to. | Comma-separated list. | N | |
| Task Name | Name or partial name of one or more tasks. | Wildcards are supported. | N | |
| 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 |
| 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 |
| n/a | Task Type of tasks to list. | Valid values: One of the following (not case sensitive):
To list tasks for all task types, enter | N | |
| n/a | If | Valid values:
Default is d. Note The time is relative to the Time Zone specified for the User. | Y | |
| n/a | Type of | Valid values:
| N | |
| n/a | ID used within the Controller to identify a workflow. | If | N |
|
| Task Name | Name of a workflow. | If | N |
|
List Tasks - Advanced
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieve task details using specific query parameter(s). |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
URI Properties | |
Example Response |
List Tasks - Advanced: XML and JSON Examples
The retainSysIds
and version
properties are specified as attributes in XML.
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
Examples | XML | JSON |
---|---|---|
Example Response |
List Tasks - Advanced: URI Properties
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| Agent | Agent on which this task was run. | N | ||
| Member of Business Services | Business Services that this task belongs to. | Comma-separated list. | N | |
| Task Name | Name or partial name of one or more tasks. | /wiki/spaces/UC71x/pages/5215217 are supported. | N | |
| 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 |
| 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 |
| n/a | Task Type of tasks to list. | Valid values: One of the following (not case sensitive):
To list tasks for all task types, enter | N | |
| n/a | If | Valid values:
Default is d.
Note The time is relative to the Time Zone specified for the User. | Y | |
| n/a | Type of | Valid values:
| N | |
| n/a | ID used within the Controller to identify a workflow. | If | N |
|
| Task Name | Name of a workflow. | If | N |
|