Overview
Universal Controller supports the following RESTful-based web services for Universal Controller system properties, which are listed alphabetically on this page.
- Properties Web Services#List Properties
- Properties Web Services#Modify a Property
- Properties Web Services#Read a Property
Formatting specifications for each web service, including details about property requirements, are provided.
List Properties
Description | |
---|---|
URI | http://host_name:port/uc/resources/property/list |
HTTP Method | GET |
Description | Retrieves information on all properties. |
Example URI | http://localhost:8080/uc/resources/property/list |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List Properties: XML and JSON Responses, below. |
List Properties Properties | See List Properties: Properties, below. |
List Properties: XML and JSON Responses
XML | JSON |
---|---|
List Properties: Properties
Property | UI Field Name | Description |
---|---|---|
| Name | Name of the property. |
| Value | Value of the property. |
Modify a Property
Description | |
---|---|
URI | http://host_name:port/uc/resources/property |
HTTP Method | PUT |
Description | Modifies the specified property. |
Example URI | http://localhost:8080/uc/resources/property?propertyname=uc.forecast.days&value=20 |
URI Parameters | See Modify a Property: URI Parameters, below. |
Example Response |
|
Modify a Property: URI Parameters
Parameter | Description | Specifications | Required |
---|---|---|---|
| Name used within the Controller to identify this property. | String; URI parameter. | Y |
| Value of this property. | Case-sensitive; URI parameter. | Y |
Read a Property
URI | http://host_name:port/uc/resources/property |
HTTP Method | GET |
Description | Retrieves information on a specific property. |
URI Parameters | See Read a Property: URI Parameters, below. |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example URI | http://localhost:8080/uc/resources/property?propertyname=uc.forecast.days |
Example Response | See Read a Property: XML and JSON Responses, below. |
Read a Property Properties |
Read a Property: URI Parameters
Parameter | Description | Specifications | Required |
---|---|---|---|
| Name used within the Controller to identify this property. | String; URI parameter. | Y |
Read a Property XML and JSON Responses
XML | JSON |
---|---|