Versions Compared

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.

...

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