Virtual Resource Web Services
Overview
Universal Controller supports the following RESTful-based web services for Virtual Resource operations, which are listed alphabetically on this page.
- Create a Virtual Resource
- Delete a Virtual Resource
- List Virtual Resources
- List Virtual Resources - Advanced
- Modify a Virtual Resource
- Read a Virtual Resource
- Set Limit on a Virtual Resource
Formatting specifications for each web service, including details about parameter requirements, are provided.
Create a Virtual Resource
|
Description |
---|---|
URI |
|
HTTP Method |
POST |
Description |
Creates a Virtual Resource. |
Example URI |
http://localhost:8080/uc/resources/virtual |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
n/a |
Example |
|
Properties |
|
Example Response |
|
Virtual Resource: XML and JSON Examples
The excludeRelated and retainsSysIds properties are specified as attributes in the XML.
XML |
JSON |
---|---|
|
|
Virtual Resource Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
n/a |
Universal Controller release that the record was exported from. |
read only | N |
|
n/a | Record table information. | read only | N |
|
Resource Limit |
Number of resources available for the specific resource type. |
Integer; |