Versions Compared

Old Version 3

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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

...

Formatting specifications for each web service, including details about parameter requirements, are provided.

...

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 propertyservice will persist the sysId property.

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


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

...

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

  • global
  • local
  • task
  • trigger

Default is global.

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

XML Response

JSON Response


Expand
titleXML Response
<variables>
    <variable exportReleaseLevel="7.2.0.0" exportTable="ops_variable" retainSysIds="true" version="2">
        <description>test 1</description>
        <name>var_1</name>
        <opswiseGroups>
            <opswiseGroup>A</opswiseGroup>
            <opswiseGroup>B</opswiseGroup>
        </opswiseGroups>
        <sysId>c4f499ac6a104d3891a5a06398c02fbe</sysId>
        <value>test1</value>
    </variable>
</variables>
OR
<variables>
    <variable><variable exportReleaseLevel="7.2.0.0" exportTable="ops_variable" >
        <description>varDescription2</description>
        <name>UT_WS_var_2</name>
        <sysId>164a03300a0a0a6475b497e5d985c1aa</sysId>
        <taskId>164a02a80a0a0a644fc9a3d6dd33f72b</taskId>
        <taskName>UT-WS-Task</taskName>
        <type>Task</type>
        <value>varVal2</value>
    </variable>
    <variable><variable exportReleaseLevel="7.2.0.0" exportTable="ops_variable" >
        <description />
        <name>UT_WS_var_2</name>
        <sysId>164ea9ff0a0a0a6449f209da49f594c0</sysId>
        <triggerId>164ea9a40a0a0a647df8372b88eb2394</triggerId>
        <triggerName>UT-WS-Trigger</triggerName>
        <type>Trigger</type>
        <value>val</value>
    </variable>
</variables>



Expand
titleJSON Response
[
    {
        "description": "test 1",
        "exportReleaseLevel": "7.2.0.0",
        "exportTable": "ops_variable",
        "name": "var_1",
        "opswiseGroups": [
            "A",
            "B"
        ],
        "retainSysIds": true,
        "sysId": "c4f499ac6a104d3891a5a06398c02fbe",
        "value": "test1",
        "version": 2
    }
]
OR
[
  {
  "description": "varDescription2",
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_variable",
  "name": "UT_WS_var_2",
  "sysId": "164a03300a0a0a6475b497e5d985c1aa",
  "taskId": "164a02a80a0a0a644fc9a3d6dd33f72b",
  "taskName": "UT-WS-Task",
  "type": "Task",
  "value": "varVal2"
  },
  {
  "description" null,
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_variable",
  "name": "UT_WS_var_2",
  "sysId": "164ea9ff0a0a0a6449f209da49f594c0",
  "triggerId": "164ea9a40a0a0a647df8372b88eb2394",
  "triggerName": "UT-WS-Trigger",
  "type": "Trigger",
  "value": "val"
  }
]


...

XML Response

JSON Response


Expand
titleXML Response
 <variable exportReleaseLevel="7.2.0.0" exportTable="ops_variable" retainSysIds="true" version="1">
	<description>description</description>
	<name>demo_ops_global</name>
	<opswiseGroups>
		<opswiseGroup>group 1</opswiseGroup>
		<opswiseGroup>group 2</opswiseGroup>
	</opswiseGroups>
	<sysId>237f9f6c43d2617201b2bd04063f917a</sysId>
	<value>Global</value>
</variable>



Expand
titleJSON Response
{
  "description": "description",
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_variable",
  "name": "demo_ops_global",
  "opswiseGroups": ["group 1","group 2"],
  "sysId": "237f9f6c43d2617201b2bd04063f917a",
  "retainSysIds": true,
  "value": "Global",
  "version": 1
}


Anchor
Set Variable
Set Variable
Set

...

Variable


Description

URI

http://host_name/uc/resources/variable/ops-variable-set

HTTP Method

POST

Description

Sets the specified variable.

Example URI

http://localhost:8080/uc/resources/variable/ops-variable-set

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

application/xml, application/json

Example Request

See Set Variables: Request Examples.

Example Response

See Set Variables: Response Examples.

Properties

See Set Variables Properties.

Anchor
Set

...

Variable Request Examples
Set

...

Variable Request Examples
Set

...

Variable: Request Examples

XML Request

JSON Request


Expand
titleXML
Global Variable
<set-variable>
    <create>true</create>
    <variable>
        <name>testGlobalVar</name>
        <description>testGlobalVar description</description>
        <value>testGlobalVar val</value>
    </variable>
</set-variable>
 
Task Variable
<set-variable>
    <create>true</create>
    <scope>task</scope>
    <task>Timer 60</task>
    <variable>
        <description>testTaskVar description</description>
        <name>testTaskVar</name>
        <value>testTaskVar val</value>
    </variable>
</set-variable>
 
Trigger Variable
<set-variable>
    <create>true</create>
    <scope>trigger</scope>
    <trigger>uc - Mon-Fri 9-5</trigger>
    <variable>
        <description>testTriggerVar description</description>
        <name>testTriggerVar</name>
        <value>testTriggerVar val</value>
    </variable>
</set-variable>



Expand
titleJSON
Global Variable
{
  "create": true,
   "variable": {
    "name": "testGlobalVar",
    "description": "testGlobalVar description",
    "value": "testGlobalVar val"
  }
}
 
Task Variable
{
  "create": true,
  "scope": "task",
  "task": "Timer 60",  
  "variable": {
    "name": "testTaskVar",
    "description": "testTaskVar description",
    "value": "testTaskVar val"
  }
}
Trigger Variable
{
  "create": true,
  "scope": "trigger",
  "trigger": "uc - Mon-Fri 9-5",  
  "variable": {
    "name": "testTriggerVar",
    "description": "testTriggerVar description",
    "value": "testTriggerVar val"
  }
}


Anchor
Set

...

Variable Response Examples
Set

...

Variable Response Examples
Set

...

Variable: Response Examples

XML Response

JSON Response


Expand
titleXML
<command-response>
    <type>set_variable</type>
    <success>true</success>
    <info>Variable testGlobalVar not found., Successfully created variable=testGlobalVar with value=testGlobalVar val.</info>
    <errors />
</command-response>



Expand
titleJSON
{
  "type": "set_variable",
  "success": true,
  "info": "Variable testGlobalVar not found., Successfully created variable=testGlobalVar with value=testGlobalVar val.",
  "errors": ""
}


Anchor
Set

...

Variable Properties
Set

...

Variable Properties
Set

...

Variable Properties

Property

UI Field Name

Description

Specifications

Required

Anchor
create - SV
create - SV
create

n/a

Specification for whether or not to create a variable.

Boolean; Valid values: true/false.

N

Anchor
description - SV
description - SV
description

Description

Description of the variable.


N

Anchor
exportReleaseLevel - SV
exportReleaseLevel - SV
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - SV
exportTable - SV
exportTable

n/aRecord table information.read onlyN

Anchor
name - SV
name - SV
name

Name

Name of the variable.


Y

Anchor
scope - SV
scope - SV
scope

n/a

Type of variable to be returned in the XML Response.

Valid values: global, task, trigger (case insensitive). Default is global.

N

Anchor
task - SV
task - SV
task

n/a

If scope is task; Name of the task.


Y

Anchor
trigger - SV
trigger - SV
trigger

n/a

If scope is trigger; Name of the trigger.


Y

Anchor
value - SV
value - SV
value

Value

Value of the variable.

Maximum = 25000 characters.

Y

...