Server Operations Web Services - Temporary Property Change

Owned by Former user (Deleted)
Aug 10, 2021

Overview

Universal Controller supports the following RESTful-based web services for the Temporary Property Change Server Operation.

Formatting specifications for the web service, including details about parameter requirements, are provided.

Temporary Property Change


Description

URI

http://host_name/uc/resources/serveroperation/temporarypropertychange

HTTP Method

POST

Description

Allows for the temporary setting of specific Universal Controller properties to be used for diagnosing problems.

This operation and setting of properties should be performed only under the guidance of Stonebranch support.

Example URI

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See Temporary Property Change: Example Response.

Request Parameters

See Temporary Property Change: Example Response.

Temporary Property Change: Example Response

XML Response

JSON Response

 XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<serverOperationResponse>
    <operation>Temporary Property Change</operation>
    <success>true</success>
    <output>Property uc.log.rpc has been set to false</output>
</serverOperationResponse>
 JSON Response
{
    "operation": "Temporary Property Change",
    "success": true,
    "output": "Property uc.log.rpc has been set to false"
}

Temporary Property Change: Request Parameters

The following request parameters will be needed for a temporary property change.

Property

UI Field Name

Description

Specifications

Required

name

Property

Name of property to be changed.


Y

value

Value

New value that named property will be changed to

Boolean value to enable/disable.

Y