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; Default is 10. | N | |
| Name | Name used within the Controller to identify this Virtual Resource. | Contains a maximum of 40 alphanumerics. | Y | |
| Member of Business Services | Business Services that this record belongs to. <opswiseGroups> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> </opswiseGroups> "opswiseGroups": ["group1","group2"] | N | ||
| n/a | For Create web services; specification for whether or not the web service should persist the sysId property.
Note In XML, | Valid values: true/false (default is true). | N | |
| Description | User-defined; description of this record. | N | ||
| N/A | System ID field in the database for a record. | Persisted only if retainSysIds is set to true. | N | |
| Resource Type | Type of Virtual Resource. | Valid values:
Default is Renewable (1). | N | |
| n/a | For Read and List web services; specification of the version being read or listed. Note In XML web services, | Yes |
Delete a Virtual Resource
Description | |
---|---|
URI | http://host_name/uc/resources/virtual |
HTTP Method | DELETE |
Description | Deletes a Virtual Resource. |
URI Parameters | |
Example URI | http://localhost:8080/uc/resources/virtual?resourceid=77171434c0a801c9016d5b2b5d17ddee |
Example Response |
|
Delete a Virtual Resource: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Virtual Resource. | String; URI parameter. | Y (unless |
|
| Name used within the Controller to identify this Virtual Resource. | String; URI parameter. | Y (unless |
|
List Virtual Resources
Description | |
---|---|
URI | http://host_name/uc/resources/virtual/list |
HTTP Method | GET |
Description | Retrieves information on all Virtual Resources. |
URI Parameters | |
Example URI | http://localhost:8080/uc/resources/virtual/list?name=test*&type=renewable |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Response Example | |
Response Properties |
List Virtual Resources: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Name of this Virtual Resource. | String; URI wild card parameter (that is, | N | resourcename |
resourcename | Name of the resource. | Wildcards are supported. | N | name |
| Type of this Virtual Resource. | Valid Values:
If | N |
List Virtual Resources: XML and JSON Response Examples
XML | JSON |
---|---|
List Virtual Resources: Response Properties
Property | UI Field Name | Description |
---|---|---|
| Resource Limit | Number of resources available for the specific resource type. |
| Name | Name used within the Controller to identify this Virtual Resource. |
| n/a | System ID field in the database for a record. |
| Resource Type | Type of Virtual Resource. |
| Resource Used | System-supplied if |
| Currently in Use | List of task instances that have acquired this virtual resource, and the number of units acquired, at the time the web service was executed. Note
|
| Version | System-supplied; version number of the virtual resource. |
List Virtual Resources - Advanced
Description | |
---|---|
URI | http://host_name/uc/resources/virtual/listadv |
HTTP Method | GET |
Description | Retrieves information on all Virtual Resources. |
URI Parameters | |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Response Example | See List Virtual Resources - Advanced: XML and JSON Response Examples. |
List Virtual Resources - Advanced: URI Parameters
Parameter | Description | Specifications | Required |
---|---|---|---|
| Name of this Virtual Resource. | String; URI wild card parameter (that is, | N |
| Type of this Virtual Resource. | Valid Values:
If | N |
businessServices | Business Services that this Virtual Resource belongs to. | String value of comma-separated Business Services. | N |
List Virtual Resources - Advanced: XML and JSON Response Examples
XML | JSON |
---|---|
Modify a Virtual Resource
Description | |
---|---|
URI | http://host_name/uc/resources/virtual |
HTTP Method | PUT |
Description | Modifies the Virtual Resource specified by the |
Example URI | http://localhost:8080/uc/resources/virtual |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example | |
Properties | |
Example Response |
|
Read a Virtual Resource
Description | |
---|---|
URI | http://host_name/uc/resources/virtual |
HTTP Method | GET |
Description | Retrieves information on a specified Virtual Resource. |
Example URI | http://localhost:8080/uc/resources/virtual?resourcename=test |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example | |
Properties |
Read a Virtual Resource: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Virtual Resource. | String; URI parameter. | Y (unless |
|
| Name used within the Controller to identify this Virtual Resource. | String; URI parameter. | Y (unless |
|
Set Limit on a Virtual Resource
Description | |
---|---|
URI | http://host_name/uc/resources/virtual/ops-update-resource-limit |
HTTP Method | POST |
Description | Updates resource limit for virtual resources. |
Example URI | http://localhost:8080/uc/resources/virtual/ops-update-resource-limit |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
Example Request | |
Request Properties | |
Example Response |
Set Limit on a Virtual Resource: XML and JSON Examples
Example | XML | JSON |
---|---|---|
Example Request | ||
Example Response |
Set Limit on a Virtual Resource: Request Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Resource Name | Name used within the Controller to identify this resource. | Maximum 40 alphanumerics. | Y |
| Resource Limit | Maximum number of units available for this resource. | Y |