Properties Web Services

Overview

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

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

 XML
<properties>
    <property>
        <name label="Administrator Email Address">uc.admin.email_addr</name>
        <value>admin@stonebranch.com</value>
    </property>
    <property>
        <name label="Agent Cache Retention Period In Days">uc.agent.cache.retention</name>
        <value>7</value>
    </property>
</properties>
 JSON
[ {
  "name": {
    "label": "Administrator Email Address",
    "value": "uc.admin.email_addr"
  },
  "value": "admin@stonebranch.com"
  },
  {
  "name": {
    "label": "Agent Cache Retention Period In Days",
    "value": "uc.agent.cache.retention"
  },
  "value": "7"
  }
]

List Properties: Properties

Property

UI Field Name

Description

name

Name

Name of the property.

value

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

  • Status 200 /OK
    Successfully updated the property with name {propertyname}.
  • Status 404 /Not Found
    A property with name {propertyname} does not exist.

Modify a Property: URI Parameters

Parameter

Description

Specifications

Required

propertyname

Name used within the Controller to identify this property.

String; URI parameter.

Y

value

Value of this property.

Case-sensitive; URI parameter.

Y

Read a Property

URI

http://host_name:port/uc/resources/property
HTTP MethodGET

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

See List Properties: Properties.

Read a Property: URI Parameters

Parameter

Description

Specifications

Required

propertyname

Name used within the Controller to identify this property.

String; URI parameter.

Y

Read a Property: XML and JSON Responses

XML

JSON

 XML
      <property>
            <name label="Forecast Period In Days">uc.forecast.days</name>
            <value>31</value>
      </property>

 JSON
{
  "name": {
    "name": "Forecast Period In Days",
    "value": "uc.forecast.days"
  },
  "value": "31"
}