-
Notifications
You must be signed in to change notification settings - Fork 0
/
12.0--ariel-searches-search_id-results-GET.html
300 lines (207 loc) · 7.65 KB
/
12.0--ariel-searches-search_id-results-GET.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
<!DOCTYPE html><html lang="en-us">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<meta name="dcterms.rights" content="© Copyright IBM Corporation 2022">
<meta name="description" content="Retrieves search results in the requested format.">
<meta name="keywords" content="/ariel/searches/{search_id}/results, GET, API, REST API">
<meta name="geo.country" content="ZZ">
<script>
digitalData = {
page: {
pageInfo: {
language: "en-us",
version: "v18",
ibm: {
country: "ZZ",
type: "CT701"
}
}
}
};
</script><!-- Licensed Materials - Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="ibmdita.css">
<link rel="Start" href="c_rest_api_version120_ariel_intro.html">
<title>GET /ariel/searches/{search_id}/results</title>
</head>
<body id="api-12.0--ariel-searches-search_id-results-GET"><main role="main"><article role="article" aria-labelledby="d55764e10">
<h1 class="topictitle1" id="d55764e10">GET /ariel/searches/{search_id}/results</h1>
<div class="body refbody"><p class="shortdesc">Retrieves search results in the requested format.</p>
<div class="section refsyn">
<p>Retrieve the results of the Ariel search that is identified by the search ID. The Accepts request header indicates the format of the result.
The formats are RFC compliant and can be JSON, CSV, XML, or tabular text.</p>
<p>By default, all query result records are returned. To restrict the results
to a contiguous subset of the records, you can supply a Range header to specify the inclusive range of records
to be returned.</p>
<p>This end-point works with query results that are generated by AQL query expressions.
This endpoint might not work as expected for results that are generated by other means.
Search results might not be retrievable for searches that are created on the Console.</p>
<p>The response samples are for the following query: Select sourceIP, destinationIP from events.</p>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /ariel/searches/{search_id}/results resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. GET /ariel/searches/{search_id}/results resource details</span></caption><colgroup><col style="width:100%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d55764e73" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d55764e73 "><p>application/json
application/csv
text/table
application/xml
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /ariel/searches/{search_id}/results request parameter details" class="defaultstyle"><caption><span class="tablecap">Table 2. GET /ariel/searches/{search_id}/results request parameter details</span></caption><colgroup><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:28.57142857142857%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d55764e121" class="thbot">Parameter</th>
<th id="d55764e124" class="thbot">Type</th>
<th id="d55764e127" class="thbot">Optionality</th>
<th id="d55764e130" class="thbot">Data Type</th>
<th id="d55764e133" class="thbot">MIME Type</th>
<th id="d55764e137" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d55764e121 "><p>search_id</p>
</td>
<td headers="d55764e124 "><p>path</p>
</td>
<td headers="d55764e127 "><p>Required</p>
</td>
<td headers="d55764e130 "><p>String</p>
</td>
<td headers="d55764e133 "><p>text/plain</p>
</td>
<td headers="d55764e137 "><p>The ID of the search criteria for the returned results.</p>
</td>
</tr>
<tr>
<td headers="d55764e121 "><p>data_lake</p>
</td>
<td headers="d55764e124 "><p>query</p>
</td>
<td headers="d55764e127 "><p>Optional</p>
</td>
<td headers="d55764e130 "><p>String</p>
</td>
<td headers="d55764e133 "><p>text/plain</p>
</td>
<td headers="d55764e137 "><p>Optional - If the search was for QCDL then "qcdl" should be entered in this field. Only "qcdl" can be entered in this field</p>
</td>
</tr>
<tr>
<td headers="d55764e121 "><p>Range</p>
</td>
<td headers="d55764e124 "><p>header</p>
</td>
<td headers="d55764e127 "><p>Optional</p>
</td>
<td headers="d55764e130 "><p>String</p>
</td>
<td headers="d55764e133 "><p>text/plain</p>
</td>
<td headers="d55764e137 "><p>Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /ariel/searches/{search_id}/results response codes" class="defaultstyle"><caption><span class="tablecap">Table 3. GET /ariel/searches/{search_id}/results response codes</span></caption><colgroup><col style="width:20%"><col style="width:20%"><col style="width:60%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d55764e255" class="thbot">HTTP Response Code</th>
<th id="d55764e258" class="thbot">Unique Code</th>
<th id="d55764e261" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d55764e255 "><p>200</p>
</td>
<td headers="d55764e258 "><p></p>
</td>
<td headers="d55764e261 "><p>The search results were retrieved.</p>
</td>
</tr>
<tr>
<td headers="d55764e255 "><p>404</p>
</td>
<td headers="d55764e258 "><p>1002</p>
</td>
<td headers="d55764e261 "><p>The search does not exist.</p>
</td>
</tr>
<tr>
<td headers="d55764e255 "><p>404</p>
</td>
<td headers="d55764e258 "><p>1003</p>
</td>
<td headers="d55764e261 "><p>Search results not found. The search is still in progress.</p>
</td>
</tr>
<tr>
<td headers="d55764e255 "><p>422</p>
</td>
<td headers="d55764e258 "><p>1005</p>
</td>
<td headers="d55764e261 "><p>A request parameter is not valid.</p>
</td>
</tr>
<tr>
<td headers="d55764e255 "><p>500</p>
</td>
<td headers="d55764e258 "><p>1020</p>
</td>
<td headers="d55764e261 "><p>An error occurred during the attempt to retrieve the search results.</p>
</td>
</tr>
<tr>
<td headers="d55764e255 "><p>503</p>
</td>
<td headers="d55764e258 "><p>1010</p>
</td>
<td headers="d55764e261 "><p>The Ariel server might be temporarily unavailable or offline. Please try again later.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="d55764e364"><h2 class="sectiontitle" id="d55764e364">Response Description</h2>
<p>The search results for the specified search ID. The format that is used to encapsulate the data depends on the format specified in the Accept header for this request.</p>
</section>
<section class="section refsyn" role="region" aria-labelledby="d55764e374"><h2 class="sectiontitle" id="d55764e374">Response Sample</h2>
<pre class="codeblock"><code>
{
"events": [
{
"sourceIP": "1.1.1.1",
"destinationIP": "127.0.0.1",
"qid": 1004
},
{
"sourceIP": "1.1.1.1",
"destinationIP": "127.0.0.1",
"qid": 1005
}
]
}
</code></pre>
</section>
</div>
<aside role="complementary" aria-labelledby="d55764e10"><nav role="navigation">
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="c_rest_api_version120_ariel_intro.html" title="Use the references for REST API 12.0 Ariel endpoints.">Ariel endpoints</a></div>
</div>
</nav></aside></article></main></body></html>