-
Notifications
You must be signed in to change notification settings - Fork 1
/
17.0--ariel-taggedfields-GET.html
315 lines (215 loc) · 10.1 KB
/
17.0--ariel-taggedfields-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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<!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="Gets the list of tagged fields.">
<meta name="keywords" content="/ariel/taggedfields, 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_version170_ariel_intro.html">
<title>GET /ariel/taggedfields</title>
</head>
<body id="api-17.0--ariel-taggedfields-GET"><main role="main"><article role="article" aria-labelledby="api-17.0--ariel-taggedfields-GET__title__1">
<h1 class="topictitle1" id="api-17.0--ariel-taggedfields-GET__title__1">GET /ariel/taggedfields</h1>
<div class="body refbody"><p class="shortdesc">Gets the list of tagged fields.</p>
<div class="section refsyn">
<p>Gets the list of tagged fields.</p>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /ariel/taggedfields resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. GET /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-GET__entry__1" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--ariel-taggedfields-GET__entry__1 "><p>application/json
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /ariel/taggedfields request parameter details" class="defaultstyle"><caption><span class="tablecap">Table 2. GET /ariel/taggedfields 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="api-17.0--ariel-taggedfields-GET__entry__3" class="thbot">Parameter</th>
<th id="api-17.0--ariel-taggedfields-GET__entry__4" class="thbot">Type</th>
<th id="api-17.0--ariel-taggedfields-GET__entry__5" class="thbot">Optionality</th>
<th id="api-17.0--ariel-taggedfields-GET__entry__6" class="thbot">Data Type</th>
<th id="api-17.0--ariel-taggedfields-GET__entry__7" class="thbot">MIME Type</th>
<th id="api-17.0--ariel-taggedfields-GET__entry__8" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--ariel-taggedfields-GET__entry__3 "><p>Range</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__4 "><p>header</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__5 "><p>Optional</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__6 "><p>String</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__7 "><p>text/plain</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__8 "><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="api-17.0--ariel-taggedfields-GET__entry__3 "><p>fields</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__4 "><p>query</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__5 "><p>Optional</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__6 "><p>String</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__7 "><p>text/plain</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__8 "><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>
<tr>
<td headers="api-17.0--ariel-taggedfields-GET__entry__3 "><p>filter</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__4 "><p>query</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__5 "><p>Optional</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__6 "><p>String</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__7 "><p>text/plain</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__8 "><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="api-17.0--ariel-taggedfields-GET__entry__3 "><p>sort</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__4 "><p>query</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__5 "><p>Optional</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__6 "><p>String</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__7 "><p>text/plain</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__8 "><p>Optional - This parameter is used to sort the elements in a list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /ariel/taggedfields response codes" class="defaultstyle"><caption><span class="tablecap">Table 3. GET /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-GET__entry__33" class="thbot">HTTP Response Code</th>
<th id="api-17.0--ariel-taggedfields-GET__entry__34" class="thbot">Unique Code</th>
<th id="api-17.0--ariel-taggedfields-GET__entry__35" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--ariel-taggedfields-GET__entry__33 "><p>200</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__34 "><p></p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__35 "><p>An array of tagged fields.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-GET__entry__33 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__34 "><p>1005</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__35 "><p>A field request parameter is not valid.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-GET__entry__33 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__34 "><p>1010</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__35 "><p>Invalid filter criteria supplied.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-GET__entry__33 "><p>422</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__34 "><p>1015</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__35 "><p>The sort field or order is not valid.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--ariel-taggedfields-GET__entry__33 "><p>500</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__34 "><p>1020</p>
</td>
<td headers="api-17.0--ariel-taggedfields-GET__entry__35 "><p>An error occurred while retrieving the tagged fields.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="api-17.0--ariel-taggedfields-GET__title__5"><h2 class="sectiontitle" id="api-17.0--ariel-taggedfields-GET__title__5">Response Description</h2>
<div class="p">An array of tagged fields. The category_id field is used as the default sort input in ascending order. A tagged field object contains the following fields:
<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-GET__title__6"><h2 class="sectiontitle" id="api-17.0--ariel-taggedfields-GET__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-GET__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>