| 92 | |
| 93 | == Info == |
| 94 | |
| 95 | === Request === |
| 96 | |
| 97 | ==== Request Format ==== |
| 98 | |
| 99 | {{{ |
| 100 | { |
| 101 | eventType: [ |
| 102 | "opsmonitoring:_____", |
| 103 | ... |
| 104 | ], |
| 105 | ts: { |
| 106 | ts: #####, // milliseconds or microseconds, defaults to now() if omitted |
| 107 | }, |
| 108 | obj: { |
| 109 | type*: _______, // string of object type (aggregate, node, interface, etc.) |
| 110 | id: [ |
| 111 | _______, // string of either urn or id of a requested target, returns all if omitted |
| 112 | ... |
| 113 | ] |
| 114 | }, |
| 115 | output: _______ // string of output format type. currently only json for info requests |
| 116 | } |
| 117 | }}} |
| 118 | |
| 119 | ==== Example Request URL ==== |
| 120 | |
| 121 | {{{ |
| 122 | http://genimondev.uky.edu/API/info/?q={"obj":{"id":["pks2.sdn.uky.edu_node_pc1"],"type":"node"},"output":"json"} |
| 123 | }}} |
| 124 | |
| 125 | === Response === |
| 126 | |
| 127 | ==== Response Format (JSON) ==== |
| 128 | |
| 129 | {{{ |
| 130 | [ |
| 131 | { |
| 132 | _____: _____, // These will be fields specific to the type of object requested |
| 133 | ... |
| 134 | }, |
| 135 | ... |
| 136 | ] |
| 137 | }}} |
| 138 | |
| 139 | ==== Response Format (XML) ==== |
| 140 | |
| 141 | ''Note: This is currently in the debugging stages, but will resemble the JSON format just using XML structures |