Versions Compared

Old Version 1

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.

...

Universal Controller supports the following RESTful-based web services for Variable operations, which are listed alphabetically on this page.

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

...


Description

URI

http://host_name/uc/resources/variable

HTTP Method

POST

Description

Creates a Global Variable.

Example URI

http://localhost:8080/uc/resources/variable

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Create a Global Variable: Example Request, below.

Request Properties

See Global Variable Web Services#Global Variable Properties, below.

Example Response

  • Status 200 /OK
    Successfully created the variable with sysId {sysId} to version {version}.

...

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

N


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.

retainSysIds

n/a

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


Html bobswift
<ul>
<li> If <b>retainSysIds</b>="true" and <code>sysId</code> is included in the request/response, <code>sysId</code> will be persisted to the database.
<li> If <b>retainSysIds</b>="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 <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

...


Description

URI

http://host_name/uc/resources/variable

HTTP Method

PUT

Description

Modifies the Global Variable specified by the sysId.

Example URI

http://localhost:8080/uc/resources/variable

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Modify a Global Variable: Example Request, below.

Request Properties

See Global Variable Web Services#Global Variable Properties.

Example Response

  • Status 200 /OK
    Successfully updated the variable with sysId <sysId> to version <version>.

...


Description

URI

http://host_name/uc/resources/variable

HTTP Method

GET

Description

Retrieves information on a specific Global Variable.

URI Parameters

See Read a Global Variable: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/variable?variablename=demo_ops_global

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See Read a Global Variable: Example Response , below.

Response Properties

See Variable Web Services#Global Global Variable Properties.

Anchor
Read a Global Variable URI Parameters
Read a Global Variable URI Parameters
Read a Global Variable: URI Parameters

...


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 Variable Web Services#Set Set Variables Properties.

Anchor
Set Variable Request Examples
Set Variable Request Examples
Set Variable: Request Examples

...