Variable Web Services
Overview
Universal Controller supports the following RESTful-based web services for Variable operations, which are listed alphabetically on this page.
- Create a Global Variable
- Delete a Global Variable
- List Variables
- List Variables - Advanced
- Modify a Global Variable
- Read a Global Variable
- Set Variable
Formatting specifications for each web service, including details about parameter requirements, are provided.
Create a Global Variable
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 Properties, below. |
Example Response |
|
Create a Global Variable: Example Request
XML Request | JSON Request |
---|---|
Global Variable Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Description | User-defined; description of this record. | N | |
| Name | Name used within the Controller to identify this Global Variable. | Contains a maximum of 40 alphanumerics. | Y |
| Member of Business Services | Business Services that this record belongs to.
| N | |
retainSysIds | n/a | Specification for whether or not the Create a Create a Global Variable web service will persist the sysId property. Note In XML, | Valid values: true/false (default is true). | N |
| n/a | System ID field in the database for a record. | Persisted only if retainSysIds is set to true. | N |
| Value | Value of this variable. | Maximum = 25000 characters. | N |
Delete a Global Variable
Description | |
---|---|
URI | http://host_name/uc/resources/variable |
HTTP Method | DELETE |
Description | Deletes a Global Variable. |
URI Parameters | See Delete a Global Variable: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/variable?variableid=dadf6b84c0a8016500a01a10da5e2c15 |
Example Response |
|
Delete a Global Variable: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Global Variable. | String; URI parameter. | Y (unless |
|
| Name used within the Controller to identify this Global Variable. | String; URI parameter. | Y (unless |
|
List Variables
Description | |
---|---|
URI | http://host_name/uc/resources/variable/list |
HTTP Method | POST |
Description | Retrieves information on variables matching specific search criteria. |
Example URI | http://localhost:8080/uc/resources/variable/list |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | application/xml, application/json |
Example Request | |
Request Properties | |
Example Response | |
Response Properties |
List Variables: XML and JSON Examples
Examples | XML | JSON |
---|---|---|
Example Request | ||
Example Response |
List Variables: Request Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| n/a | Type of variable to be returned in the Response. | Valid values (case insensitive):
Default is global. | N |
| n/a | If | Y | |
| n/a | If | Y | |
| n/a | If | Wildcards are supported. | N |
List Variables: Response Properties
Property | UI Field Name | Description |
---|---|---|
| Description | Description of the variable. |
| Name | Name of the variable. |
| n/a | sys_id used within the Controller to identify this variable. |
| n/a | ID of the task if the search was for a task-specific variable ( |
| n/a | Name of the task if the search was for a task-specific variable ( |
| n/a | ID of the trigger if the search was for a trigger-specific variable ( |
| n/a | Name of the trigger if the search was for a trigger-specific variable ( |
| n/a | Type of variable. |
| Value | Value of the variable. |
| Version | Version of the variable. |
| Value Options | Not for Global Variables. <options> <option>option1</option> <option>option2</option> </options> Note An Duplicate |
| Allow Empty Option | Not for Global Variables.
|
| Allow Unlisted Option | Not for Global Variables.
|
List Variables - Advanced
List Variables - Advanced support filtering results using business services that the variables belongs to. It is only applicable for global and local scope variables.
When passing the business services as a request filter for local scope variable, the results will be filtered on the task or triggers, which belongs to the specified business services.
For task and/or trigger scope , business services filter can be ignored.
Description | |
---|---|
URI | http://host_name/uc/resources/variable/listadv |
HTTP Method | GET |
Description | Retrieves variables details using specific query parameters. |
Example URI |
|
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
URI Properties | |
Example Response |
List Variables - Advanced: URI Parameters
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 |
List Variables - Advanced: Example Response
XML Response | JSON Response |
---|---|
Modify a Global Variable
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 | |
Example Response |
|
Modify a Global Variable: Example Request
XML Request | JSON Request |
---|---|
Read a Global Variable
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 |
Read a Global Variable: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this Global Variable. | Y |
| |
| Name used within the Controller to identify this Global Variable. | Maximum 40 alphanumerics. | Y |
|
Read a Global Variable: Example Response
XML Response | JSON Response |
---|---|
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 | |
Example Response | |
Properties |
Set Variable: Request Examples
XML Request | JSON Request |
---|---|
Set Variable: Response Examples
XML Response | JSON Response |
---|---|
Set Variable Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| n/a | Specification for whether or not to create a variable. | Boolean; Valid values: true/false. | N |
| Description | Description of the variable. | N | |
| n/a | Universal Controller release that the record was exported from. | read only | N |
| n/a | Record table information. | read only | N |
| Name | Name of the variable. | Y | |
| n/a | Type of variable to be returned in the XML Response. | Valid values: global, task, trigger (case insensitive). Default is global. | N |
| n/a | If | Y | |
| n/a | If | Y | |
| Value | Value of the variable. | Maximum = 25000 characters. | Y |