System Property Update System Property

System Property Update System Property

Updates the specified system property (by object id or name). Expects an _update object containing the field(s) to be updated and their corresponding value(s).

Privileges required:

UPDATE SYSTEM_PROPERTY

Request
URI
POST
https://{api_host}/portal/rest/systemProperty/updateSystemProperty
COPY
Request Body

Show optional properties

{
    "_update": {}
}
{
    "name": "string",
    "id": 0,
    "_update": {
        "name": "string",
        "value": "string",
        "defaultValue": "string",
        "isPassword": false,
        "isReadOnly": false,
        "dataType": "string",
        "description": "string"
    }
}
string
name
Optional

name

integer
id
Optional

id

object
_update
Required

_update

Responses
200

Request was successfully processed

Returns system_property_update_system_property_result of type(s) application/json
This response body class contains all of the following: Inlinesystem_property_update_system_property_result0 
{
    "rows": 1
}

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"_update:"object"}' https://{api_host}/portal/rest/systemProperty/updateSystemProperty
On This Page
System Property Operations
POST
System Property Get System Properties
POST
System Property Get System Property
POST
System Property Insert Or Update System Property
POST
System Property Insert System Property
POST
System Property Update System Property