Differences

This shows you the differences between two versions of the page.

--- tengine:api [2022/06/09 01:16] – twinny
+++ tengine:api [2022/06/09 01:21] – [DescribeTable] twinny
@@ Line 153: / Line 153: @@
     "string"=STRING
   }
+  sortorder="ASC"/"DESC" - set the sort order to be returned. ASC by default. Note this is sorted by string value: not numeric
+  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/returned items. Useful for pagination
+  conditions=ARRAY of ARRAYS e.g. {  {"begins_with", "sort_"}, {">", "sort_5"}, {"<", "sort_15"} }
 }
+</code>
+=== Return Format ===
+<code javascript>
+{
+  result=[KEYS,DATA]
+  success=BOOLEAN
+  readcount=INTEGER  - how many items were read and returned (after limit, startat, conditions)
+  foundcount=INTEGER - how many items were intiially found
+  error=STRING
+}
+</code>
+=== Example Request ===
+<code javascript>
+tbd
+</code>
+=== Example Return ===
+<code javascript>
+tbd
 </code>
@@ Line 257: / Line 282: @@
 }
 </code>
+==== ListTables ====
+tbd
+==== DescribeTable ====
+tbd
+----
 ~~DISCUSSION~~