Versions Compared

Old Version 2

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...


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

Anchor
Example Response
Example Response
Example Response

See List Properties: XML and JSON Responses, below.

List Properties Properties

See List Properties: Properties, below.

Anchor
List Properties XML and JSON Responses
List Properties XML and JSON Responses

...

XML

JSON


Expand
titleXML


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



Expand
titleJSON


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


...


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.

...

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

Anchor
Example Response
Example Response
Example Response

See Read a Property: XML and JSON Responses, below.

Read a Property Properties

See List Properties: Properties.

Anchor
Read a Property URI Parameters
Read a Property URI Parameters

...

XML

JSON


Expand
titleXML


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




Expand
titleJSON


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