Page Comparison

...

Universal Controller supports the following RESTful-based web services for Virtual Resource operations, which are listed alphabetically on this page.

Virtual Resource Web Services#Create Create a Virtual ResourceVirtual Resource Web Services#Delete
Delete a Virtual Resource
List Virtual Resource Web Services#List Virtual Resources
List Virtual Resource Web Services#List Virtual Resources - Advanced
Virtual Resource Web Services#Modify Modify a Virtual ResourceVirtual Resource Web Services#Read
Read a Virtual Resource
Virtual Resource Web Services#Set Set Limit on a Virtual Resource

Formatting specifications for each web service, including details about parameter requirements, are provided.

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	exportReleaseLevel - CVR
	exportReleaseLevel - CVR

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	exportTable - CVR
	exportTable - CVR

exportTable

n/a

Record table information.

read only

N

Anchor

	limit - CVR
	limit - CVR

limit

Resource Limit

Number of resources available for the specific resource type.

Integer; Default is 10.

N

Anchor

	name - CVR
	name - CVR

name

Name

Name used within the Controller to identify this Virtual Resource.

Contains a maximum of 40 alphanumerics.

Y

Anchor

	opswiseGroups - CVR
	opswiseGroups - CVR

opswiseGroups

Member of Business Services

Business Services that this record belongs to.

XML

Panel
<opswiseGroups> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> </opswiseGroups>

JSON

Anchor

Panel

N

"opswiseGroups": ["group1","group2"]

N

Anchor

	retainSysIds - CVR
	retainSysIds - CVR

retainSysIds

n/a

For Create web services; specification for whether or not the web service should persist the sysId property.

If retainSysIds is true and sysId is included in the request/response, sysId will be persisted to the database.
If retainSysIds is false and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

title	Note

In XML, retainSysIds is specified as an attribute in the <virtualResource> element.

Valid values: true/false (default is true).

N

Anchor

	summary - CVR
	summary - CVR

summary

Description

User-defined; description of this record.

N

Anchor

	sysId - CVR
	sysId - CVR

sysId

N/A

System ID field in the database for a record.

Persisted only if retainSysIds is set to true.

N

Anchor

	type - CVR
	type - CVR

type

Resource Type

Type of Virtual Resource.

Valid values:

As String = Renewable, As Value = 1
As String = Boundary, As Value = 2
As String = Depletable, As Value = 3

Default is Renewable (1).

N

Anchor

	version - CVR
	version - CVR

version

n/a

For Read and List web services; specification of the version being read or listed.

Note

title	Note

In XML web services, version is specified as an attribute in the <virtualResource> element.

Yes

Parameter	Description	Specifications	Required	Mutually Exclusive With
`name`	Name of this Virtual Resource.	String; URI wild card parameter (that is, `test*`).	N	`resourcename`
`resourcename`	Name of the resource.	Wildcards are supported.	N	`name`
`type`	Type of this Virtual Resource.	Valid Values: As String = Renewable, As Value = 1 As String = Boundary, As Value = 2 As String = Depletable, As Value = 3 If `type` is not specified, it defaults to all types.	N

Versions Compared

Old Version 1

New Version Current

Key