Difference between revisions of "GetKeyValues"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns a Person object for an specific ID. This method can be used by anonymous login or logged user. |Parameters= {{Api_Parameter| Para...") |
|||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | + | Gets a tree of components-groups-keys. | |
This method can be used by anonymous login or logged user. | This method can be used by anonymous login or logged user. | ||
| Line 13: | Line 13: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=components |
| − | |ParamType= | + | |ParamType=String |
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=Comma-separated components' name to filter the response tree. It is case insensitive. |
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=groups | ||
| + | |ParamType=String | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Comma-separated groups' name to filter the response tree. It is case insensitive. | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=keys | ||
| + | |ParamType=String | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Comma-separated keys' name to filter the response tree. It is case insensitive. | ||
}} | }} | ||
|Returns= | |Returns= | ||
| − | + | First, second and third levels of ParameterComponent tree, which contains filtered keys inside groups inside components | |
'''Example:''' | '''Example:''' | ||
| Line 34: | Line 46: | ||
|Exceptions= | |Exceptions= | ||
| − | * | + | * None |
|Cache= | |Cache= | ||
| Line 49: | Line 61: | ||
! Changes author | ! Changes author | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| − | ! | + | ! 2.4 |
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
Revision as of 13:17, 3 September 2015
Description
{{{Description}}}
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
- None
Caching
This method is cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.4 | Initial method design | Harley Cabral |
