Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

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


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


 
JSON


Anchor
retainSysIds - CVRretainSysIds - 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 property..


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



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:values:


Html bobswift
<ul>
<li> As String = Renewable, As Value = 1
<li> As String = Boundary, As Value = 2
<li> As String = Depletable, As Value = 3
</ul>


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:


Html bobswift
<ul>
<li> As String = Renewable, As Value = 1
<li> As String = Boundary, As Value = 2
<li> As String = Depletable, As Value = 3
</ul>


If type is not specified, it defaults to all types.

N


...