Versions Compared

Version Old Version 7 New Version Current
Changes made by

IT Stonebranch

Stonebranch

Saved on

Key

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

...

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


Property

UI Field Name

Description

Specifications

Required

Anchor
description - GV
description - GV
description

Description

User-defined; description of this record.


N

Anchor
name - GV
name - GV
name

Name

Name used within the Controller to identify this Global Variable.

Contains a maximum of 40 alphanumerics.

Y

Anchor
opswiseGroups - GV
opswiseGroups - GV
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


Panel


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




N

Anchor
retainSysIds - GV
retainSysIds - GV
retainSysIds

n/a

Specification for whether or not the Create a Create a Global Variable web service will persist the sysId property.

Html bobswift
Note
titleNote

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


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

N

Anchor
sysId - GV
sysId - GV
sysId

n/a

System ID field in the database for a record.

Persisted only if retainSysIds is set to true.

N

Anchor
vale - GV
vale - GV
value

Value

Value of this variable.

Maximum = 25000 characters.

N

...

<ul> <li> global <li> local <li> task <li> trigger </ul>
  • global
  • local
  • task
  • trigger

Default is global.

Property

UI Field Name

Description

Specifications

Required

Anchor
scope - LReq
scope - LReq
scope

n/a

Type of variable to be returned in the Response.

Valid values (case insensitive):

Html bobswift

N

Anchor
taskName - LReq
taskName - LReq
taskName

n/a

If scope is task; Name of task.


Y

Anchor
triggerName - LReq
triggerName - LReq
triggerName

n/a

If scope is trigger; Name of the trigger.


Y

Anchor
variableName - LReq
variableName - LReq
variableName

n/a

If scope is global (or local), and variableName is not specified, all Global (or Local) variables are returned in the Response.
 
If scope is Global (or Local), and variableName is specified, all Global (or Local) variables matching that name are returned in the Response.

Wildcards are supported.

N

...

Parameter

Description


Specifications

Required

businessServices

n/a

Business Services that this Variable belongs to.

String value of comma separated business service

N

scope

n/a

Type of variable to be returned in the Response.

Valid values (case insensitive):

  • global

  • local

  • task

  • trigger

Default is global.

N

taskname

n/a

If scope is task; Name of task.


Y (if scope = task)

triggername

n/a

If scope is trigger; Name of the trigger.


Y (if scope = trigger)

variablename

n/a

  • If scope is global (or local), and variableName is not specified, all Global (or Local) variables are returned in the Response.
  • If scope is global (or local), and variableName is specified, all Global (or Local) variables matching that name are returned in the Response.

Wildcards are supported.

N

Anchor
List Variables - Advanced Example Response
List Variables - Advanced Example Response
List Variables - Advanced: Example Response

...