Changes between Version 12 and Version 13 of GENIMonitoring/API

Timestamp:

06/23/16 15:13:51 (8 years ago)

Author:

Caylin Hickey

Comment:

Added example queries from Tom's attachment

GENIMonitoring/API

@@ -152 +152 @@
 
 ''Note on infoType:
-           ''simple - Returns a list with the object details
-           ''detailed - Returns a list with the object details as well as any child objects associated to said object
+            * '''simple''' - Returns a list with the object details
+            * '''detailed''' - Returns a list with the object details as well as any child objects associated to said object
 
 ==== Valid Info Request Object Types ====
@@ -207 +207 @@
   ]
 }}}
+
+= Example Queries =
+
+ * Get a list of aggregates in JSON format (SImple meaning just the aggregate itself, not its children)
+
+{{{
+http://genimon.uky.edu/API/info/?q={"obj":{"type":"aggregate"},"output":"json","infoType":"simple"}
+}}}
+
+ * Get a list of aggregates in XML format
+
+{{{
+http://genimon.uky.edu/API/info/?q={"obj":{"type":"aggregate"},"output":"xml","infoType":"simple"}
+}}}
+
+ * Get information about a single aggregate by short name in JSON format
+
+{{{
+http://genimon.uky.edu/API/info/?q={"obj":{"id":["max-ig"],"type":"aggregate"},"output":"json","infoType":"simple"}
+}}}
+
+ * Get information about a single aggregate by short name in XML format
+
+{{{
+http://genimon.uky.edu/API/info/?q={"obj":{"id":["max-ig"],"type":"aggregate"},"output":"xml","infoType":"simple"}
+}}}
+
+ * Get information about a single aggregate by URN in JSON format
+
+{{{
+http://genimon.uky.edu/API/info/?q={"obj":{"id":["urn:publicid:IDN+instageni.maxgigapop.net+authority+cm"],"type":"aggregate"},"output":"json","infoType":"simple"}
+}}}
+
+ * Get information about a single aggregate by URN in XML format
+
+{{{
+http://genimon.uky.edu/API/info/?q={"obj":{"id":["urn:publicid:IDN+instageni.maxgigapop.net+authority+cm"],"type":"aggregate"},"output":"xml","infoType":"simple"}
+}}}
+
+ * Get event information about an aggregate
+
+{{{
+http://genimon.uky.edu/API/data/?q={"obj":{"id":["max-ig"],"type":"aggregate"},"output":"xml","ts":{"gte":1456260153962,"lt":1456263753962}}
+}}}
+
+ *  Just is_available for an aggregate in XML format
+
+{{{
+http://genimon.uky.edu/API/data/?q={"eventType":["is_available"],"obj":{"id":["max-ig"],"type":"aggregate"},"output":"xml","ts":{"gte":1456345005000,"lt":1456348605000}}
+}}}
+
+ *  Just is_available for an aggregate in JSON format
+
+{{{
+http://genimon.uky.edu/API/data/?q={"eventType":["is_available"],"obj":{"id":["max-ig"],"type":"aggregate"},"output":"json","ts":{"gte":1456345005000,"lt":1456348605000}}
+}}}
+
+ *  List all slivers in XML
+
+{{{
+http://genimon.uky.edu/API/info/?q={"obj":{"type":"sliver"},"output":"xml","infoType":"simple"}
+}}}
+
+ *  Info about a single sliver in json
+
+{{{
+http://genimon.uky.edu/API/info/?q={"obj":{"id":["lan.sdn.uky.edu_sliver_38337"],"type":"sliver"},"output":"json","infoType":"detailed"}
+}}}