Find all System Properties
get
/iam/governance/api/v1/systemconfiguration/
Retrieves all system properties by providing the property name as URL parameters. Sorting and pagination are supported.
Request
Query Parameters
-
limit(optional): integer(int32)
Number of System Properties to be returned from startindex.
-
offset(optional): integer(int32)
Pagination startindex from which results need to be returned.
-
orderBy(optional): string
Attribute on which sorting needs to be done followed by colon and sort order.
-
property(optional): string
Property name that need to be searched.
Response
Supported Media Types
- application/json
200 Response
successful operation.
Nested Schema : SystemProperty
Type:
Show Source
object-
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.
400 Response
Invalid input.
Examples
The following example shows how to retreive all system properties by providing property names as URL parameters in GET request submission using cURL. Sorting and pagination are supported. 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'
Example of Response Body
The following example shows the JSON response for a request to retrieve all the system properties:
{
"links":[
{
"rel":"self",
"href":"http://pseudo.com/iam/governance/adminservice/api/v1/systemconfiguration?offset=1&limit=10"
},
{
"rel":"first",
"href":"http://pseudo.com/iam/governance/adminservice/api/v1/systemconfiguration?offset=1&limit=10"
},
{
"rel":"next",
"href":"http://pseudo.com/iam/governance/adminservice/api/v1/systemconfiguration?offset=11&limit=10"
}
],
"count":10,
"hasMore":true,
"totalResult":162,
"offset":1,
"limit":10,
"systemPropertyTOS":[
{
"id":"118",
"ptyKeyword":"demoKey2",
"ptyValue":"2",
"ptyName":"demoName2",
"ptyDataLevel":"2"
},
{
"id":"117",
"ptyKeyword":"demoKey2",
"ptyValue":"true",
"ptyName":"demoName2",
"ptyDataLevel":"2"
},
{
"id":"53",
"ptyKeyword":"demoKey2",
"ptyValue":"FALSE",
"ptyName":"demoName2",
"ptyDataLevel":"2"
},
{
"id":"116",
"ptyKeyword":"demoKey2",
"ptyValue":"-1",
"ptyName":"demoName2",
"ptyDataLevel":"2"
},
{
"id":"96",
"ptyKeyword":"demoKey2",
"ptyValue":"[^\\w]",
"ptyName":"demoName2",
"ptyDataLevel":"2"
},
{
"id":"55",
"ptyKeyword":"demoKey2",
"ptyValue":"demoValue2",
"ptyName":"demoName2",
"ptyDataLevel":"2"
},
{
"id":"54",
"ptyKeyword":"demoKey2",
"ptyValue":"demoValue2",
"ptyName":"demoName2",
"ptyDataLevel":"2"
},
{
"id":"52",
"ptyKeyword":"demoKey2",
"ptyValue":"demoValue2",
"ptyName":"demoName2",
"ptyDataLevel":"2"
},
{
"id":"56",
"ptyKeyword":"demoKey2",
"ptyValue":"15",
"ptyName":"demoName2",
"ptyDataLevel":"2"
},
{
"id":"153",
"ptyKeyword":"demoKey2",
"ptyValue":"demoValue2",
"ptyName":"demoName2",
"ptyDataLevel":"2"
}
]
}