Changes between Version 12 and Version 13 of GENIMonitoring/API


Ignore:
Timestamp:
06/23/16 15:13:51 (5 years ago)
Author:
Caylin Hickey
Comment:

Added example queries from Tom's attachment

Legend:

Unmodified
Added
Removed
Modified
  • GENIMonitoring/API

    v12 v13  
    152152
    153153''Note on infoType:
    154            ''simple - Returns a list with the object details
    155            ''detailed - Returns a list with the object details as well as any child objects associated to said object
     154            * '''simple''' - Returns a list with the object details
     155            * '''detailed''' - Returns a list with the object details as well as any child objects associated to said object
    156156
    157157==== Valid Info Request Object Types ====
     
    207207  ]
    208208}}}
     209
     210= Example Queries =
     211
     212 * Get a list of aggregates in JSON format (SImple meaning just the aggregate itself, not its children)
     213
     214{{{
     215http://genimon.uky.edu/API/info/?q={"obj":{"type":"aggregate"},"output":"json","infoType":"simple"}
     216}}}
     217
     218 * Get a list of aggregates in XML format
     219
     220{{{
     221http://genimon.uky.edu/API/info/?q={"obj":{"type":"aggregate"},"output":"xml","infoType":"simple"}
     222}}}
     223
     224 * Get information about a single aggregate by short name in JSON format
     225
     226{{{
     227http://genimon.uky.edu/API/info/?q={"obj":{"id":["max-ig"],"type":"aggregate"},"output":"json","infoType":"simple"}
     228}}}
     229
     230 * Get information about a single aggregate by short name in XML format
     231
     232{{{
     233http://genimon.uky.edu/API/info/?q={"obj":{"id":["max-ig"],"type":"aggregate"},"output":"xml","infoType":"simple"}
     234}}}
     235
     236 * Get information about a single aggregate by URN in JSON format
     237
     238{{{
     239http://genimon.uky.edu/API/info/?q={"obj":{"id":["urn:publicid:IDN+instageni.maxgigapop.net+authority+cm"],"type":"aggregate"},"output":"json","infoType":"simple"}
     240}}}
     241
     242 * Get information about a single aggregate by URN in XML format
     243
     244{{{
     245http://genimon.uky.edu/API/info/?q={"obj":{"id":["urn:publicid:IDN+instageni.maxgigapop.net+authority+cm"],"type":"aggregate"},"output":"xml","infoType":"simple"}
     246}}}
     247
     248 * Get event information about an aggregate
     249
     250{{{
     251http://genimon.uky.edu/API/data/?q={"obj":{"id":["max-ig"],"type":"aggregate"},"output":"xml","ts":{"gte":1456260153962,"lt":1456263753962}}
     252}}}
     253
     254 *  Just is_available for an aggregate in XML format
     255
     256{{{
     257http://genimon.uky.edu/API/data/?q={"eventType":["is_available"],"obj":{"id":["max-ig"],"type":"aggregate"},"output":"xml","ts":{"gte":1456345005000,"lt":1456348605000}}
     258}}}
     259
     260 *  Just is_available for an aggregate in JSON format
     261
     262{{{
     263http://genimon.uky.edu/API/data/?q={"eventType":["is_available"],"obj":{"id":["max-ig"],"type":"aggregate"},"output":"json","ts":{"gte":1456345005000,"lt":1456348605000}}
     264}}}
     265
     266 *  List all slivers in XML
     267
     268{{{
     269http://genimon.uky.edu/API/info/?q={"obj":{"type":"sliver"},"output":"xml","infoType":"simple"}
     270}}}
     271
     272 *  Info about a single sliver in json
     273
     274{{{
     275http://genimon.uky.edu/API/info/?q={"obj":{"id":["lan.sdn.uky.edu_sliver_38337"],"type":"sliver"},"output":"json","infoType":"detailed"}
     276}}}