Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revisionLast revisionBoth sides next revision | ||
| tengine:api [2022/06/09 01:16] – twinny | tengine:api [2022/06/09 01:27] – twinny | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ===== API Documentation ===== | ===== API Documentation ===== | ||
| + | |||
| + | ( I accidentally nuked all documentation so It's currently being rebuilt! May be some missing parts of old/invalid details ) | ||
| This page provides details on how you can use TEngine via API calls | This page provides details on how you can use TEngine via API calls | ||
| Line 153: | Line 155: | ||
| " | " | ||
| } | } | ||
| + | sortorder=" | ||
| + | startat=INTEGER - if set, skips the number of items configured here before potentially read and returning items. Useful for pagination | ||
| + | limit=INTEGER - if set, limits the number of read/ | ||
| + | conditions=ARRAY of ARRAYS e.g. { {" | ||
| } | } | ||
| + | </ | ||
| + | |||
| + | === Return Format === | ||
| + | <code javascript> | ||
| + | { | ||
| + | result=[KEYS, | ||
| + | success=BOOLEAN | ||
| + | readcount=INTEGER | ||
| + | foundcount=INTEGER - how many items were intiially found | ||
| + | error=STRING | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | === Example Request === | ||
| + | <code javascript> | ||
| + | tbd | ||
| + | </ | ||
| + | |||
| + | === Example Return === | ||
| + | <code javascript> | ||
| + | tbd | ||
| </ | </ | ||
| Line 257: | Line 284: | ||
| } | } | ||
| </ | </ | ||
| + | |||
| + | ==== ListTables ==== | ||
| + | |||
| + | tbd | ||
| + | |||
| + | ==== DescribeTable ==== | ||
| + | |||
| + | tbd | ||
| + | |||
| + | ---- | ||
| ~~DISCUSSION~~ | ~~DISCUSSION~~ | ||