Universal Monitor Task Web Services
Overview
Universal Controller supports the following RESTful-based web services for Variable Monitor Task operations, which are listed alphabetically on this page.
Formatting specifications for each web service, including details about parameter requirements, are provided.
Links to detailed information about the properties used in these web services also is located on this page.
For information on Task web services that are applicable to all task types, see:
Create a Universal Monitor Task
Description | |
---|---|
URI | http://host_name/uc/resources/task |
HTTP Method | POST |
Description | Creates a new Universal Monitor task. To persist sysIds, use the retainSysIds property. |
Example URI | http://localhost:8080/uc/resources/task |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example | See Universal Monitor Task: XML and JSON Examples, below. |
Properties | See Properties. |
Example Response |
|
Modify a Universal Monitor Task
Description | |
---|---|
URI | http://host_name/uc/resources/task |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
HTTP Method | PUT |
Description | Modifies the task specified by the sysId in the request. To modify Universal Monitor Task properties without modifying related records, use the excludeRelated property. |
Example | |
Properties | See Properties. |
Example Response |
|
Read a Universal Monitor Task
Description | |
---|---|
URI | http://host_name/uc/resources/task |
HTTP Method | GET |
Description | Retrieves information on the specified task. |
Request Parameters |
|
Mutually Exclusive Parameters |
|
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response |
|
Properties | See Properties. |
Universal Monitor Task: XML and JSON Examples
The retainSysIds
and version
properties are specified as attributes in XML.
The exportReleaseLevel
and /wiki/spaces/UC71x/pages/5179227 properties are specified as attributes in XML.
Examples | XML | JSON |
---|---|---|
Example for Task |
See Task Web Services - Task Actions for XML and JSON examples of task actions.
See Task Web Services - Task-Related Records for XML and JSON examples of task-related records.