REST API for System Property in OIG

Fetch a System Property

get

/iam/governance/api/v1/systemconfiguration/systemproperty/{keyword}

Fetches a particular System Property with the specified keyword.

Request

Path Parameters

keyword: string

Get a particular System Property by its keyword.

Response

Supported Media Types

application/json

200 Response

successful operation.

Root Schema : SystemProperty

Type: object

Show Source

id(optional): string

Id of system property.
ptyDataLevel(optional): string

Property data level of system property.
ptyKeyword(optional): string

Keyword of system property.
ptyName(optional): string

Name of system property.
ptyValue(optional): string

Value of system property.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of system property."
        },
        "ptyKeyword":{
            "type":"string",
            "description":"Keyword of system property."
        },
        "ptyValue":{
            "type":"string",
            "description":"Value of system property."
        },
        "ptyName":{
            "type":"string",
            "description":"Name of system property."
        },
        "ptyDataLevel":{
            "type":"string",
            "description":"Property data level of system property."
        }
    }
}

400 Response

Invalid input.

Examples

The following example shows how to retreive a particular system property with the specified keyword by submitting a GET request on the REST resource using cURL. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl -i -X GET -u username:password  \
--header 'Content-Type: application/json' \
'http://pseudo.com/iam/governance/adminservice/api/v1/systemconfiguration/systemproperty/demoKey2'

Example of Response Body

The following example shows the JSON response for a request to retrieve the system properties with the specified keyword:

{
   "id":"168",
   "ptyKeyword":"demoKey2",
   "ptyValue":"demoValue2",
   "ptyName":"demoName2",
   "ptyDataLevel":"0"
}