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:
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
- Agent File Monitor Task Web Services
- Email Task Web Services
- Email Monitor Task Web Services
- IBM i Task Web Services
- File Transfer Task Web Services
- Linux Unix Task Web Services
- Manual Task Web Services
- PeopleSoft Task Web Services
- Recurring Task Web Services
- Remote File Monitor 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
- z/OS Monitor 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 |