Page Comparison

...

The excludeRelated and retainsSysIds properties are specified as attributes in the <virtualResource> element of the requestXML.

XML

JSON

Expand

title	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>

Expand

title	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"
 }

...

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

JSON

panel

Html bobswift
<pre> <opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups> </pre>

JSON

Panel

Html bobswift
<pre> "opswiseGroups": ["test"] </pre>

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

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:

.

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

...

XML

JSON

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<virtualResources>
    <virtualResource exportReleaseLevel="7.2.0.0" exportTable="ops_virtual_resource" retainSysIds="true" version="3">
        <limit>1</limit>
        <name>VR-1</name>
        <opswiseGroups>
            <opswiseGroup>A</opswiseGroup>
        </opswiseGroups>
        <summary>VR test 1</summary>
        <sysId>10e1664d8fe44a4482c6b6d6a64ecc05</sysId>
        <type>Renewable</type>
    </virtualResource>
    <virtualResource retainSysIds="true" version="2">
        <limit>1</limit>
        <name>VR-2</name>
        <opswiseGroups>
            <opswiseGroup>B</opswiseGroup>
        </opswiseGroups>
        <summary>VR test 2</summary>
        <sysId>459020efeff3476682be1a6c8df8f799</sysId>
        <type>Boundary</type>
    </virtualResource>
    <virtualResource  <virtualResourceexportReleaseLevel="7.2.0.0" exportTable="ops_virtual_resource" retainSysIds="true" version="1">
        <limit>1</limit>
        <name>VR-3</name>
        <opswiseGroups>
            <opswiseGroup>C</opswiseGroup>
        </opswiseGroups>
        <summary>test 3</summary>
        <sysId>f4bfd4882af24948b6f7abd7baad91b1</sysId>
        <type>Depletable</type>
    </virtualResource>
</virtualResources>

Expand

title	JSON

[
    {
  </virtualResource>
</virtualResources>

Expand

title	JSON

[
    {
        "exportReleaseLevel": "7.2.0.0",
        "exportTable": "ops_virtual_resource",
        "limit": 1,
        "name": "VR-1",
        "opswiseGroups": [
            "A"
        ],
        "retainSysIds": true,
        "summary": "VR test 1",
        "sysId": "10e1664d8fe44a4482c6b6d6a64ecc05",
        "type": "Renewable",
        "version": 3": 3
    },
    {
        "exportReleaseLevel": "7.2.0.0",
      },  "exportTable": "ops_virtual_resource",
  {         "limit": 1,
        "name": "VR-2",
        "opswiseGroups": [
            "B"
        ],
        "retainSysIds": true,
        "summary": "VR test 2",
        "sysId": "459020efeff3476682be1a6c8df8f799",
        "type": "Boundary",
        "version": 2
    },
    {
        "exportReleaseLevel": "7.2.0.0",
        "exportTable": "ops_virtual_resource",
        "limit": 1,
        "name": "VR-3",
        "opswiseGroups": [
            "C"
        ],
        "retainSysIds": true,
        "summary": "test 3",
        "sysId": "f4bfd4882af24948b6f7abd7baad91b1",
        "type": "Depletable",
        "version": 1
    }
]

...

Versions Compared

Old Version 2

New Version Current

Key