...
Universal Controller supports the following RESTful-based web services for Variable operations, which are listed alphabetically on this page.
- Variable Web Services#Create Create a Global VariableVariable Web Services#Delete
- Delete a Global Variable
- Variable Web Services#List List VariablesVariable Web Services#List
- List Variables - Advanced
- Variable Web Services#Modify Modify a Global VariableVariable Web Services#Read
- Read a Global Variable
- Set Variable Web Services#Set Variable
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 Variable Web Services#Global Global Variable Properties, below. |
Example Response |
|
...
Property | UI Field Name | Description | Specifications | Required | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
scope | n/a | Type of variable to be returned in the Response. | Valid values (case insensitive): Html bobswift |
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 | ||||
---|---|---|---|---|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/variable |
HTTP Method | PUT |
Description | Modifies the Global Variable specified by the |
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 Variable Web Services#Global Global Variable Properties. |
Example Response |
|
...
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 | ||||
---|---|---|---|---|
|
...
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 | See Variable Web Services#Set Set Variables Properties. |
Anchor | ||||
---|---|---|---|---|
|
...