-
Notifications
You must be signed in to change notification settings - Fork 0
/
12.0--analytics-building_blocks-GET.html
292 lines (199 loc) · 8.67 KB
/
12.0--analytics-building_blocks-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
<!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 a list of building block rules.">
<meta name="keywords" content="/analytics/building_blocks, 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_analytics_intro.html">
<title>GET /analytics/building_blocks</title>
</head>
<body id="api-12.0--analytics-building_blocks-GET"><main role="main"><article role="article" aria-labelledby="d44699e10">
<h1 class="topictitle1" id="d44699e10">GET /analytics/building_blocks</h1>
<div class="body refbody"><p class="shortdesc">Retrieves a list of building block rules.</p>
<div class="section refsyn">
<p>Retrieves a list of building block rules.</p>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /analytics/building_blocks resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. GET /analytics/building_blocks resource details</span></caption><colgroup><col style="width:100%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d44699e64" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d44699e64 "><p>application/json
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /analytics/building_blocks request parameter details" class="defaultstyle"><caption><span class="tablecap">Table 2. GET /analytics/building_blocks 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="d44699e112" class="thbot">Parameter</th>
<th id="d44699e115" class="thbot">Type</th>
<th id="d44699e118" class="thbot">Optionality</th>
<th id="d44699e121" class="thbot">Data Type</th>
<th id="d44699e124" class="thbot">MIME Type</th>
<th id="d44699e128" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d44699e112 "><p>Range</p>
</td>
<td headers="d44699e115 "><p>header</p>
</td>
<td headers="d44699e118 "><p>Optional</p>
</td>
<td headers="d44699e121 "><p>String</p>
</td>
<td headers="d44699e124 "><p>text/plain</p>
</td>
<td headers="d44699e128 "><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>
<tr>
<td headers="d44699e112 "><p>filter</p>
</td>
<td headers="d44699e115 "><p>query</p>
</td>
<td headers="d44699e118 "><p>Optional</p>
</td>
<td headers="d44699e121 "><p>String</p>
</td>
<td headers="d44699e124 "><p>text/plain</p>
</td>
<td headers="d44699e128 "><p>Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.</p>
</td>
</tr>
<tr>
<td headers="d44699e112 "><p>fields</p>
</td>
<td headers="d44699e115 "><p>query</p>
</td>
<td headers="d44699e118 "><p>Optional</p>
</td>
<td headers="d44699e121 "><p>String</p>
</td>
<td headers="d44699e124 "><p>text/plain</p>
</td>
<td headers="d44699e128 "><p>Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /analytics/building_blocks response codes" class="defaultstyle"><caption><span class="tablecap">Table 3. GET /analytics/building_blocks 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="d44699e246" class="thbot">HTTP Response Code</th>
<th id="d44699e249" class="thbot">Unique Code</th>
<th id="d44699e252" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d44699e246 "><p>200</p>
</td>
<td headers="d44699e249 "><p></p>
</td>
<td headers="d44699e252 "><p>The building block rules were retrieved.</p>
</td>
</tr>
<tr>
<td headers="d44699e246 "><p>422</p>
</td>
<td headers="d44699e249 "><p>1010</p>
</td>
<td headers="d44699e252 "><p>A request parameter is not valid.</p>
</td>
</tr>
<tr>
<td headers="d44699e246 "><p>500</p>
</td>
<td headers="d44699e249 "><p>1020</p>
</td>
<td headers="d44699e252 "><p>An error occurred during the attempt to retrieve the building block rules.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="d44699e309"><h2 class="sectiontitle" id="d44699e309">Response Description</h2>
<div class="p">An array of Building Block Rule objects. An Building Block Rule object contains the following fields:
<ul>
<li><strong>id</strong> - Long - The sequence ID of the building block rule.</li>
<li><strong>name</strong> - String - The name of the building block rule.</li>
<li><strong>building_block_type</strong> - String - The type of building block rule: EVENT, FLOW, COMMON, USER.</li>
<li><strong>enabled</strong> - Boolean - True if the building block rule is enabled.</li>
<li><strong>owner</strong> - String - The owner of the building block rule.</li>
<li><strong>origin</strong> - String - The origin of the building block rule: SYSTEM, OVERRIDE, USER.</li>
<li><strong>base_capacity</strong> - Long - The base capacity of the building block rule in events per second.</li>
<li><strong>base_host_id</strong> - Long - The ID of the host from which the building block rule's base capacity was determined</li>
<li><strong>average_capacity</strong> - Long - The moving average capacity, in EPS, of the building block rule across all hosts.</li>
<li><strong>capacity_timestamp</strong> - Long - The epoch timestamp, in milliseconds, since the building block's capacity values were last updated.</li>
<li><strong>identifier</strong> - String - The unique ID of the rule. This value is typically in the form of a UUID, with the exception of legacy system rules.</li>
<li><strong>linked_rule_identifier</strong> - String - The linked ID of the rule. This value is typically in the form of a UUID, with the exception of legacy system rules, and varies depending on the rule's origin as follows:
<ul>
<li><strong>SYSTEM</strong> - The identifier value of the override rule, if one exists. If the system rule has not been overridden, the value will be null.</li>
<li><strong>OVERRIDE</strong> - The identifier value of the system rule being overridden.</li>
<li><strong>USER</strong> - The value will be null.</li>
</ul>
</li>
<li><strong>creation_date</strong> - Long - The number of milliseconds since epoch when the rule was created.</li>
<li><strong>modification_date</strong> - Long - The number of milliseconds since epoch when the rule was last modified.</li>
</ul>
</div>
</section>
<section class="section refsyn" role="region" aria-labelledby="d44699e411"><h2 class="sectiontitle" id="d44699e411">Response Sample</h2>
<pre class="codeblock"><code>
[
{
"average_capacity": 42,
"base_capacity": 42,
"base_host_id": 42,
"capacity_timestamp": 42,
"creation_date": 42,
"enabled": true,
"id": 42,
"identifier": "String",
"linked_rule_identifier": "String",
"modification_date": 42,
"name": "String",
"origin": "String <one of: SYSTEM, OVERRIDE, USER>",
"owner": "String",
"type": "String <one of: EVENT, FLOW, COMMON, OFFENSE>"
}
]
</code></pre>
</section>
</div>
<aside role="complementary" aria-labelledby="d44699e10"><nav role="navigation">
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="c_rest_api_version120_analytics_intro.html" title="Use the references for REST API 12.0 analytics endpoints.">Analytics endpoints</a></div>
</div>
</nav></aside></article></main></body></html>