/
Virtual Resource Web Services

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

See Virtual Resource: XML and JSON Examples.

Properties

See Virtual Resource: Properties.

Example Response

  • Status 200 /OK
    Successfully created the Business Service with sysId {sysId}.
  • Status 400 /Bad Request
    Create virtual resource failed. Resource Name must be defined.

Virtual Resource: XML and JSON Examples

The excludeRelated and retainsSysIds properties are specified as attributes in the XML.

XML

JSON

 XML
<virtualResource exportReleaseLevel="7.2.0.0" exportTable="ops_virtual_resource" retainSysIds="true">
  <limit>1</limit>
  <name>test</name>
  <opswiseGroups>
     <opswiseGroup>1</opswiseGroup>
  </opswiseGroups>
  <summary>Resource with limit of only 1.</summary>
  <sysId>416d78bac0a801c901de14704e00fa75</sysId>
  <type>Renewable</type>
</virtualResource>
 JSON
{
  "exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_virtual_resource",
"limit": 5, "name": "test", "opswiseGroups": [ "1" ], "retainSysIds": true, "summary": "Resource with limit of only 1.", "sysId": "416d78bac0a801c901de14704e00fa75", "type": "Renewable" }

Virtual Resource Properties

Property

UI Field Name

Description

Specifications

Required

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only N

exportTable

n/a Record table information. read only N

limit

Resource Limit

Number of resources available for the specific resource type.

Integer;