plugin:struct:remote_api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:struct:remote_api [2017-07-12 11:34] – [Methods] saveData() added grosse | plugin:struct:remote_api [2023-11-23 00:20] (current) – Reformatted Klap-in | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | <= [[plugin: | ||
+ | |||
====== remote API ====== | ====== remote API ====== | ||
+ | |||
The struct plugin exposes several methods that can be accessed via the [[devel: | The struct plugin exposes several methods that can be accessed via the [[devel: | ||
+ | Note: The method names are prefixed with '' | ||
===== Methods ===== | ===== Methods ===== | ||
* **'' | * **'' | ||
- parameter: **string** //The page to get data for// | - parameter: **string** //The page to get data for// | ||
- parameter: **string** //The schema to use, empty for all// | - parameter: **string** //The schema to use, empty for all// | ||
- | - paramter: **int** //A timestamp if you want historic data (0 for now)// | + | - parameter: **int** //A timestamp if you want historic data (0 for now)// |
* returns: **array** '' | * returns: **array** '' | ||
* **'' | * **'' | ||
Line 13: | Line 17: | ||
- parameter: **string** //summary// | - parameter: **string** //summary// | ||
* return **bool** //returns always true// | * return **bool** //returns always true// | ||
+ | * **'' | ||
+ | - parameter: **string** //the schema to query, empty for all// | ||
+ | * return **array** | ||
+ | * **'' | ||
+ | - parameter: **array** //array of strings with the schema-names// | ||
+ | - parameter: **array** //array of strings with the columns// | ||
+ | - parameter: **array** //array of arrays with// '' | ||
+ | - parameter: **string** //string indicating the column to sort by// | ||
+ | * return **array** //array of rows, each row is an array of the column values// | ||
+ | |||
+ | Postman example for getAggregationData(), | ||
+ | |||
+ | < | ||
+ | <?xml version=" | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
plugin/struct/remote_api.1499852052.txt.gz · Last modified: 2017-07-12 11:34 by grosse