Charts
Service Id: platform6.charts
1. Get JSON List of Chart Service Items
| Header key |
Description |
Value |
platform6.request.action |
The action to perform (required) |
list |
A valid response will be:
| Header key |
Description |
platform6.response.status |
OK |
platform6.response.value |
JSON List |
2. Get Chart Item (ChartItem) as JSON
| Header key |
Description |
Value |
platform6.request.action |
The action to perform (required) |
get |
id |
Service item id (required) |
|
A valid response will be:
| Header key |
Description |
platform6.response.status |
OK |
platform6.response.value |
JSON Item (ChartItem) |
3. Build a Translated Chart
| Header key |
Description |
Value |
platform6.request.action |
The action to perform (required) |
process |
id |
Service item id (required) |
|
language |
Language/Locale to use (optional) |
|
A valid response will be:
| Header key |
Description |
platform6.response.status |
OK |
platform6.response.value |
JSON Chart Model |
4. Store Chart Configuration In Cache
| Header key |
Description |
Value |
platform6.request.action |
The action to perform (required) |
update.config |
id |
Service item id (required) |
|
config |
JSON Chart Model (required) |
|
A valid response will be:
| Header key |
Description |
platform6.response.status |
OK |
5. Rebuild Chart Model and Optionally Store In Cache
| Header key |
Description |
Value |
platform6.request.action |
The action to perform (required) |
synchronize |
id |
Service item id (required) |
|
language |
Language/Locale to use (optional) |
|
A valid response will be:
| Header key |
Description |
platform6.response.status |
OK |
platform6.response.value |
JSON Chart Model |
6. Get A Charts Config Given Its Id
| Header key |
Description |
Value |
platform6.request.action |
The action to perform (required) |
get.config |
id |
Service item id (required) |
|
A valid response will be:
| Header key |
Description |
platform6.response.status |
OK |
platform6.response.value |
JSON Chart Config |
7. Get A Charts Data Given Its Id
| Header key |
Description |
Value |
platform6.request.action |
The action to perform (required) |
get.data |
id |
Service item id (required) |
|
language |
Language/Locale to use (optional) |
|
force |
Skip cache and rebuild (optional) |
true or false |
A valid response will be:
| Header key |
Description |
platform6.response.status |
OK |
platform6.response.value |
JSON Chart Data |