GetKeyValues

From Gvp-public
Revision as of 15:33, 13 November 2017 by Id02660 (talk | contribs)
Jump to navigation Jump to search

Description

Gets a tree of components-groups-keys.

This method can be used by anonymous login or logged user.

Parameters

  • instanceId (Int, required)
A valid InstanceID
  • components (String, required)
Comma-separated components' name to filter the response tree. It is case insensitive.
  • groups (String, optional)
Comma-separated groups' name to filter the response tree. It is case insensitive.
  • keys (String, optional)
Comma-separated keys' name to filter the response tree. It is case insensitive.


Returns

First, second and third levels of ParameterComponent tree, which contains filtered keys inside groups inside components

Example:

{

"Statuscode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content":{
"global": {
"ANALYTICS": {
"ANALYTICS_BATCH_SIZE": 100,
"ANALYTICS_BATCH_TIME_LIMIT": 86400
}
}
}

}

In case component, groups or keys doesn't exist, the response contains a void content {}.


Exceptions


Caching

This method is cached.


Known issues

  • None


Version history

API Version Number Change description Changes author
2.4 Initial method design Harley Cabral


See also