Get a list of system registry keys.
get
/learn.rest/v1/systemRegistryKeys
Request
Query Parameters
-
totalResults(optional): boolean
If set to true, payload includes the total number of rows that satisfies the request. Use of parameter determines if the 'last' link is displayed for a pageable collection.
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/json
200 Response
Metadata-catalog collection fetched.
Root Schema : SystemRegistryKeysResponse
Type:
object
Response object for System registry keys.
Show Source
-
items(optional):
array items
array of items
-
links(optional):
array links
Array of links
Example:
{
"items":[
{
"id":"GeneratePassword",
"value":"1",
"category":"RestApiSettings",
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/systemRegistryKeys/GeneratePassword"
}
]
},
{
"id":"TriggerUserMessages",
"value":"0 or 1",
"category":"RestApiSettings",
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/systemRegistryKeys/TriggerUserMessages"
}
]
}
],
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/systemRegistryKeys"
}
]
}
Nested Schema : items
Type:
array
array of items
Show Source
-
Array of:
object User
Response object for system registry.
Nested Schema : User
Type:
object
Response object for system registry.
Show Source
-
category(optional):
string
Category of the key.
-
id(optional):
string
Name of the key.
-
links(optional):
array links
Array of System Registry links.
-
value(optional):
string
Value of the key.
Example:
{
"id":"GeneratePassword",
"value":"1",
"category":"RestApiSettings",
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/systemRegistryKeys/GeneratePassword"
}
]
}
Nested Schema : SystemRegistryKeyLinkItems
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/users/456
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}
401 Response
500 Response
Internal server error.