System Property Get System Property

System Property Get System Property

Gets the specified system property. Specify by object id or name.

Privileges required:

READ SYSTEM_PROPERTY

Request
URI
POST
https://{api_host}/portal/rest/systemProperty/getSystemProperty
COPY
Request Body
{
    "isAsync": false,
    "networkId": 0,
    "name": "string",
    "id": 0
}
boolean
isAsync
Optional

isAsync

integer
networkId
Optional
Constraints: minimum: 1

networkId

string
name
Optional

name

integer
id
Optional
Constraints: minimum: 1

id

Responses
200

Request was successfully processed

Returns system_property_get_system_property_result of type(s) application/json
This response body class contains all of the following: Inlinesystem_property_get_system_property_result0 
{
    "id": 0,
    "created": "string",
    "name": "string",
    "value": "string",
    "defaultValue": "string",
    "isReadOnly": false,
    "isPassword": false,
    "dataType": "string",
    "description": "string",
    "modified": "string"
}

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 '{}' https://{api_host}/portal/rest/systemProperty/getSystemProperty
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