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...") |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=Gets a tree of components-groups-keys. |
| − | This method | + | This method doesn't need token |
|Parameters= | |Parameters= | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=instanceId |
| + | |ParamType=Int | ||
| + | |ParamRequired=required | ||
| + | |ParamDescription=A valid InstanceID | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=components | ||
|ParamType=String | |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| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=keys |
| − | |ParamType= | + | |ParamType=String |
| − | |ParamRequired= | + | |ParamRequired=optional |
| − | |ParamDescription= | + | |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 28: | Line 40: | ||
: <span style="color: #a11">"Severity"</span>: 1, | : <span style="color: #a11">"Severity"</span>: 1, | ||
: <span style="color: #a11">"StatusMessage"</span>: "OK", | : <span style="color: #a11">"StatusMessage"</span>: "OK", | ||
| − | : <span style="color: #a11">"Content"</span>: | + | : <span style="color: #a11">"Content"</span>:{ |
| − | :: { | + | :: "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= | |Exceptions= | ||
| − | * [[ | + | * [[StatusCode#InvalidInputParameter | InvalidInputParameter]] |
|Cache= | |Cache= | ||
| Line 49: | Line 68: | ||
! Changes author | ! Changes author | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| − | ! | + | ! 2.4 |
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
Latest revision as of 15:33, 13 November 2017
Description
Gets a tree of components-groups-keys.
This method doesn't need token
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
- }
- }
- "ANALYTICS": {
- }
- "global": {
}
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 |
