-
Notifications
You must be signed in to change notification settings - Fork 1
/
17.0--ariel-taggedfields-POST.html
384 lines (263 loc) · 12.3 KB
/
17.0--ariel-taggedfields-POST.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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<!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 2023">
<meta name="description" content="Creates a new tagged field. To use this endpoint, you must have System Administrator or Security Admin permissions.">
<meta name="keywords" content="/ariel/taggedfields, POST, 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_version170_ariel_intro.html">
<title>POST /ariel/taggedfields</title>
</head>
<body id="api-17.0--ariel-taggedfields-POST"><main role="main"><article role="article" aria-labelledby="api-17.0--ariel-taggedfields-POST__title__1">
<h1 class="topictitle1" id="api-17.0--ariel-taggedfields-POST__title__1">POST /ariel/taggedfields</h1>
<div class="body refbody"><p class="shortdesc">Creates a new tagged field. To use this endpoint, you must have System Administrator or Security Admin permissions.</p>
<div class="section refsyn">
<p>Creates a tagged field.
To use this endpoint, you must have System Administrator or Security Admin permissions.</p>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/taggedfields resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. POST /ariel/taggedfields resource details</span></caption><colgroup><col style="width:100%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="api-17.0--ariel-taggedfields-POST__entry__1" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__1 "><p>application/json
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/taggedfields request body details" class="defaultstyle"><caption><span class="tablecap">Table 2. POST /ariel/taggedfields request body details</span></caption><colgroup><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:28.57142857142857%"><col style="width:28.57142857142857%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="api-17.0--ariel-taggedfields-POST__entry__3" class="thbot">Parameter</th>
<th id="api-17.0--ariel-taggedfields-POST__entry__4" class="thbot">Data Type</th>
<th id="api-17.0--ariel-taggedfields-POST__entry__5" class="thbot">MIME Type</th>
<th id="api-17.0--ariel-taggedfields-POST__entry__6" class="thbot">Description</th>
<th id="api-17.0--ariel-taggedfields-POST__entry__7" class="thbot">Sample</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__3 "><p>body</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__4 "><p>Object</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__5 "><p>application/json</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__6 "><div class="p">The structure of the tagged field. The following fields can be set when creating a new tagged field:
<ul>
<li><strong>name</strong> - String - The name of the tagged field.</li>
<li><strong>type</strong> - String - The type of the tagged field. Possible values are: NULL, STRUCT, Byte, Short, Integer, Long, UnsignedByte, UnsignedShort, UnsignedInt, UnsignedLong, BigInteger, Double, Float, Port, Host, HostV4V6, HostV6, MACAddress, String, ByteArray, UnsignedIntHex, Boolean, Binary</li>
<li><strong>private_enterprise_number</strong> - Integer - The Private Enterprise Number (e.g. IANA) for this tagged field.</li>
<li><strong>element_id</strong> - Integer - The ID of the information element that this tagged field will represent. The element_id field combined with the private_enterprise_number field defines a particular portion of data within a QFlow record. The IANA standard information elements (with a private enterprise number greater than 0) are documented here: https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-elements.</li>
<li><strong>category_id</strong> - Integer - The ID of the logical group that this tagged field belongs to in the UI.</li>
<li><strong>is_array</strong> - Boolean - Specifies whether the tagged field is a list.</li>
<li><strong>description</strong> - String - (Optional) Description for the tagged field.</li>
</ul>
</div>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__7 "><p>{
"category_id": 42,
"creation_date": 42,
"description": "String",
"element_id": 42,
"is_array": true,
"modified_date": 42,
"name": "String",
"private_enterprise_number": 42,
"tag": 42,
"type": "String",
"uuid": "String"
}</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/taggedfields response codes" class="defaultstyle"><caption><span class="tablecap">Table 3. POST /ariel/taggedfields 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="api-17.0--ariel-taggedfields-POST__entry__13" class="thbot">HTTP Response Code</th>
<th id="api-17.0--ariel-taggedfields-POST__entry__14" class="thbot">Unique Code</th>
<th id="api-17.0--ariel-taggedfields-POST__entry__15" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>201</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p></p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>The tagged field was created.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>409</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4000</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>A tagged field already exists with this private_enterprise_number and element_id.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>409</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4001</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>A tagged field already exists with this name.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4002</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>You must specify the private_enterprise_number parameter.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4003</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>The specified private_enterprise_number cannot be negative.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4004</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>You must specify the element_id parameter.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4005</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>You must specify the category_id parameter.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4006</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>The specified category ID is invalid.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4007</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>You must specify the name parameter.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4008</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>The specified name must be between 1 and 255 (inclusive) characters.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4009</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>You must specify the type parameter.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4010</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>The specified type is invalid.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>4011</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>You must specify the is_array parameter.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-POST__entry__13 "><p>500</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__14 "><p>1023</p>
</td>
<td headers="api-17.0--ariel-taggedfields-POST__entry__15 "><p>An error occurred while creating the new tagged field.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="api-17.0--ariel-taggedfields-POST__title__5"><h2 class="sectiontitle" id="api-17.0--ariel-taggedfields-POST__title__5">Response Description</h2>
<div class="p">201 response with the new tagged field structure. Location header set to the URL of the new tagged field ID.
<ul>
<li><strong>id</strong> - Long - The ID of the tagged field.</li>
<li><strong>tag</strong> - Integer - Unique number for this tagged field. This is a system-generated number produced from the private_enterprise_number and the element_id fields.</li>
<li><strong>name</strong> - String - The name of the tagged field.</li>
<li><strong>category_id</strong> - Integer - The ID of the logical group that this tagged field belongs to in the UI.</li>
<li><strong>is_array</strong> - Boolean - Specifies whether the tagged field is a list.</li>
<li><strong>description</strong> - String - (Optional) Description for the tagged field.</li>
<li><strong>type</strong> - String - The type of the tagged field. Possible values are: NULL, STRUCT, Byte, Short, Integer, Long, UnsignedByte, UnsignedShort, UnsignedInt, UnsignedLong, BigInteger, Double, Float, Port, Host, HostV4V6, HostV6, MACAddress, String, ByteArray, UnsignedIntHex, Boolean, Binary</li>
<li><strong>uuid</strong> - String - The ID for this tagged field, represented as a UUID.</li>
<li><strong>modified_date</strong> - Long - The time that the tagged field was last modified, specified in milliseconds since epoch.</li>
<li><strong>creation_date</strong> - Long - The time that the tagged field was created, specified in milliseconds since epoch.</li>
</ul>
</div>
</section>
<section class="section refsyn" role="region" aria-labelledby="api-17.0--ariel-taggedfields-POST__title__6"><h2 class="sectiontitle" id="api-17.0--ariel-taggedfields-POST__title__6">Response Sample</h2>
<pre class="codeblock"><code>
{
"category_id": 42,
"creation_date": 42,
"description": "String",
"id": 42,
"is_array": true,
"modified_date": 42,
"name": "String",
"tag": 42,
"type": "String",
"uuid": "String"
}
</code></pre>
</section>
</div>
<aside role="complementary" aria-labelledby="api-17.0--ariel-taggedfields-POST__title__1"><nav role="navigation">
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="c_rest_api_version170_ariel_intro.html" title="Use the references for REST API 17.0 ariel endpoints.">ariel endpoints</a></div>
</div>
</nav></aside></article></main></body></html>