Difference between revisions of "GetKeyValues"

From Gvp-public
Jump to navigation Jump to search
Line 46: Line 46:
  
 
|Exceptions=
 
|Exceptions=
* None
+
* [[Exceptions#InvalidInputParameter InvalidInputParameter]]
  
 
|Cache=
 
|Cache=

Revision as of 13:22, 3 September 2015

Description

Gets a tree of components-groups-keys.

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

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • 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":
{ Object of Person }

}


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