...
- Create a Global Variable
- Delete a Global Variable
- List Variables
- List Variables - Advanced
- Modify a Global Variable
- Read a Global Variable
- Set VariablesVariable
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
Property | UI Field Name | Description | Specifications | Required | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
description | Description | User-defined; description of this record. | N | |||||||||||||||
name | Name | Name used within the Controller to identify this Global Variable. | Contains a maximum of 40 alphanumerics. | Y | ||||||||||||||
opswiseGroups | Member of Business Services | Business Services that this record belongs to.
| N | |||||||||||||||
| n/a | Specification for whether or not the Create a Create a Global Variable web service will persist the sysId property | n/a | Specification for whether or not the Create a Create a Global Variable web service will persist the sysId property.
| Valid values: true/false (default is true). | N | ||||||||||||
sysId | n/a | System ID field in the database for a record. | Persisted only if retainSysIds is set to true. | N | ||||||||||||||
value | Value | Value of this variable. | Maximum = 25000 characters. | N |
...
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
scope | n/a | Type of variable to be returned in the Response. | Valid values (case insensitive):
Default is global. | N | ||||||
taskName | n/a | If | Y | |||||||
triggerName | n/a | If | Y | |||||||
variableName | n/a | If | Wildcards are supported. | N |
...
Parameter | Description | Specifications | Required | |
---|---|---|---|---|
| n/a | Business Services that this Variable belongs to. | String value of comma separated business service | N |
| n/a | Type of variable to be returned in the Response. | Valid values (case insensitive):
Default is global. | N |
| n/a | If scope is task; Name of task. | Y (if | |
| n/a | If scope is trigger; Name of the trigger. | Y (if | |
| n/a |
| Wildcards are supported. | N |
Anchor | ||||
---|---|---|---|---|
|
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
...
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 | |
Example Response | |
Properties |
Anchor | ||
---|---|---|
|
...
|
...
|
...
Variable: Request Examples
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||
---|---|---|
|
...
|
...
|
...
Variable: Response Examples
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||
---|---|---|
|
...
|
...
|
...
Variable Properties
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
create | n/a | Specification for whether or not to create a variable. | Boolean; Valid values: true/false. | N | ||||||
description | Description | Description of the variable. | N | |||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | ||||||
exportTable | n/a | Record table information. | read only | N | ||||||
name | Name | Name of the variable. | Y | |||||||
scope | n/a | Type of variable to be returned in the XML Response. | Valid values: global, task, trigger (case insensitive). Default is global. | N | ||||||
task | n/a | If | Y | |||||||
trigger | n/a | If | Y | |||||||
value | Value | Value of the variable. | Maximum = 25000 characters. | Y |
...