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

...

retainSysIds

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

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

JSON

Anchor

retainSysIds - CVR retainSysIds - CVR

Panel

N

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 propertythe 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 4

New Version Current

Key