Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

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


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 onlyN

Anchor
exportTable - CVR
exportTable - CVR
exportTable

n/aRecord table information.read onlyN

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


<pre> &lt;opswiseGroups&gt;
<opswiseGroups>
      <opswiseGroup>group1</opswiseGroup>
  
&lt;opswiseGroup&gt;test&lt;/opswiseGroup&gt; &lt;/opswiseGroups&gt;
    <opswiseGroup>group2</opswiseGroup>
</
pre>
opswiseGroups>
Panel
Html bobswift


 
JSON


<pre>
"opswiseGroups": ["
test
group1","group2"]
</pre>
Panel
Html bobswift



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.

Html bobswift
Note
titleNote

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
titleNote

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
resourcenameName of the resource.

Wildcards are supported.

Nname

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


...