Skip to content

Commit ebe38ba

Browse files
documentation update for querying aggregated-objects endpoint (#272)
* docs update for querying aggregated-objects endpoint
1 parent 097eafe commit ebe38ba

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

wiki/markdown/curl-examples.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Most endpoints are also documented in the [Eiffel Intelligence backend repositor
1818
* [/backends](#backends)
1919
* [/templates](#templates)
2020
* [/information](#information)
21-
* [/query](#query)
21+
* [/aggregated-objects](#aggregated-objects)
22+
* [/failed-notifications](#failed-notifications)
2223
* [/rules](#rules)
2324
* [/subscriptions](#subscriptions)
2425

@@ -230,7 +231,7 @@ The response is a json object containing all the connected components and data a
230231

231232
curl -X GET -H "Content-type: application/json" localhost:8080/information
232233

233-
## <a id="query" />/query
234+
## <a id="aggregated-objects" />/aggregated-objects
234235

235236
<table>
236237
<tr>
@@ -239,23 +240,37 @@ The response is a json object containing all the connected components and data a
239240
<th>Explanation</th>
240241
</tr>
241242
<tr>
242-
<td>/queryAggregatedObject</td>
243+
<td>/aggregated-objects/{id}</td>
243244
<td>GET</td>
244-
<td>Download a subscription template json file</td>
245-
</tr>
245+
<td>query an aggregated object with its id</td>
246+
</tr>
246247
<tr>
247-
<td>/queryMissedNotifications</td>
248-
<td>GET</td>
249-
<td>Queries any missed notifications</td>
250-
</tr>
251-
<tr>
252-
<td>/query</td>
248+
<td>/aggregated-objects/query</td>
253249
<td>POST</td>
254250
<td>Free style query; user specified queries</td>
255-
</tr>
251+
</tr>
256252
</table>
257253

258-
Example curl commands to these endpoints [can be found here](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/query.md) and [here](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/query-aggregated-objects.md)
254+
Example curl commands to these endpoints [can be found here](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/query-aggregated-objects.md)
255+
256+
## <a id="failed-notifications" />/failed-notifications
257+
258+
<table>
259+
<tr>
260+
<th>Endpoint</th>
261+
<th>Type</th>
262+
<th>Explanation</th>
263+
</tr>
264+
<tr>
265+
<td>/failed-notifications</td>
266+
<td>GET</td>
267+
<td>Queries any failed notifications</td>
268+
</tr>
269+
</table>
270+
271+
Example curl commands to these endpoints [can be found here](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/failed-notifications.md)
272+
273+
259274

260275
## <a id="rules" />/rules
261276

0 commit comments

Comments
 (0)