/
Properties Web Services

Properties Web Services

Jul 10, 2024

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

 

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

JSON

<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>

[ { "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

Property

UI Field Name

Description

name

Name

Name of the property.

value

Value

Value of the property.

Modify a Property

 

Description

 

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.