-
Notifications
You must be signed in to change notification settings - Fork 1
/
17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST.html
362 lines (247 loc) · 16.1 KB
/
17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-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
<!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="Cancels the dependent the building block rule task.">
<meta name="keywords" content="/analytics/building_blocks/building_block_dependent_tasks/{task_id}, 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_analytics_intro.html">
<title>POST /analytics/building_blocks/building_block_dependent_tasks/{task_id}</title>
</head>
<body id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST"><main role="main"><article role="article" aria-labelledby="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__title__1">
<h1 class="topictitle1" id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__title__1">POST /analytics/building_blocks/building_block_dependent_tasks/{task_id}</h1>
<div class="body refbody"><p class="shortdesc">Cancels the dependent the building block rule task.</p>
<div class="section refsyn">
<p>Cancels the dependent building block rule task.</p>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/building_blocks/building_block_dependent_tasks/{task_id} resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. POST /analytics/building_blocks/building_block_dependent_tasks/{task_id} 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--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__1" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__1 "><p>application/json
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/building_blocks/building_block_dependent_tasks/{task_id} request parameter details" class="defaultstyle"><caption><span class="tablecap">Table 2. POST /analytics/building_blocks/building_block_dependent_tasks/{task_id} 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--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__3" class="thbot">Parameter</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__4" class="thbot">Type</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__5" class="thbot">Optionality</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__6" class="thbot">Data Type</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__7" class="thbot">MIME Type</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__8" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__3 "><p>task_id</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__4 "><p>path</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__5 "><p>Required</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__6 "><p>Number (Integer)</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__7 "><p>text/plain</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__8 "><p>null</p>
</td>
</tr>
<tr>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__3 "><p>fields</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__4 "><p>header</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__5 "><p>Optional</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__6 "><p>String</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__7 "><p>text/plain</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__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>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/building_blocks/building_block_dependent_tasks/{task_id} request body details" class="defaultstyle"><caption><span class="tablecap">Table 3. POST /analytics/building_blocks/building_block_dependent_tasks/{task_id} 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--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__21" class="thbot">Parameter</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__22" class="thbot">Data Type</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__23" class="thbot">MIME Type</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__24" class="thbot">Description</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__25" class="thbot">Sample</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__21 "><p>task</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__22 "><p>Object</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__23 "><p>application/json</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__24 "><p>null</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__25 "><p>{
"status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>"
}</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/building_blocks/building_block_dependent_tasks/{task_id} response codes" class="defaultstyle"><caption><span class="tablecap">Table 4. POST /analytics/building_blocks/building_block_dependent_tasks/{task_id} 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--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__31" class="thbot">HTTP Response Code</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__32" class="thbot">Unique Code</th>
<th id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__33" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__31 "><p>200</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__32 "><p></p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__33 "><p>The Delete Task Status has been retrieved.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__31 "><p>404</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__32 "><p>1002</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__33 "><p>The Dependent Task Status does not exist.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__31 "><p>409</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__32 "><p>1004</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__33 "><p>The task is in a completed state</p>
</td>
</tr>
<tr>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__31 "><p>422</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__32 "><p>1005</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__33 "><p>A request parameter is not valid</p>
</td>
</tr>
<tr>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__31 "><p>500</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__32 "><p>1020</p>
</td>
<td headers="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__entry__33 "><p>An error occurred during the attempt to update the Dependent Task Status.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__title__6"><h2 class="sectiontitle" id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__title__6">Response Description</h2>
<div class="p">A Dependent Task Status object and the location header set to the task status url "/api/analytics/building_blocks/building_block_dependent_tasks/{task_id}". A Dependent Task Status object contains the following fields:
<ul>
<li><strong>id</strong> - Long - The ID of the task.</li>
<li><strong>message</strong> - String - The localized task message.</li>
<li><strong>status</strong> - String - The current state of the task.</li>
<li><strong>name</strong> - String - The name of the task.</li>
<li><strong>created_by</strong> - String - The name of the user who started the task.</li>
<li><strong>cancelled_by</strong> - String - The name of the user who requested the cancellation of the task.</li>
<li><strong>created</strong> - Long - The time in milliseconds since epoch since the task was created.</li>
<li><strong>started</strong> - Long - The time in milliseconds since epoch since the task was started.</li>
<li><strong>modified</strong> - Long - The time in milliseconds since epoch since the task was modified.</li>
<li><strong>completed</strong> - Long - The time in milliseconds since epoch since the task was completed.</li>
<li><strong>number_of_dependents</strong> - Long - The number of dependents found. The value is null until the task completes.</li>
<li><strong>maximum</strong> - Long - The maximum number of objects to check for dependency.</li>
<li><strong>progress</strong> - Long - The number of objects that were checked for dependency.</li>
<li><strong>task_components</strong> - Array - An array of task component objects. A task component object contains the following fields
<ul>
<li><strong>message</strong> - String - The localized sub-task status message.</li>
<li><strong>status</strong> - String - The current state of the the sub-task.</li>
<li><strong>sub_task_type</strong> - String - The type of the sub-task</li>
<li><strong>maximum</strong> - Long - The maximum number of objects to check for dependency.</li>
<li><strong>progress</strong> - Long - The number of objects that were checked for dependency.</li>
<li><strong>created</strong> - Long - The time in milliseconds since epoch since the sub-task was created.</li>
<li><strong>started</strong> - Long - The time in milliseconds since epoch since the sub-task was started.</li>
<li><strong>modified</strong> - Long - The time in milliseconds since epoch since the sub-task was modified.</li>
<li><strong>completed</strong> - Long - The time in milliseconds since epoch since the sub-task was completed.</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="section refsyn" role="region" aria-labelledby="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__title__7"><h2 class="sectiontitle" id="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__title__7">Response Sample</h2>
<pre class="codeblock"><code>
{
"cancelled_by": "String",
"completed": 42,
"created": 42,
"created_by": "String",
"id": 42,
"maximum": 42,
"message": "String",
"modified": 42,
"name": "String",
"number_of_dependents": 42,
"progress": 42,
"started": 42,
"status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>",
"task_components": [
{
"completed": 42,
"created": 42,
"maximum": 42,
"message": "String",
"modified": 42,
"number_of_dependents": 42,
"progress": 42,
"started": 42,
"status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>",
"task_sub_type": "String <one of: FIND_DEPENDENT_ARIEL_SAVED_SEARCHES, FIND_DEPENDENT_OFFENSE_SAVED_SEARCHES, FIND_DEPENDENT_ASSET_SAVED_SEARCHES, FIND_DEPENDENT_VULNERABILITY_SAVED_SEARCHES, FIND_DEPENDENT_ADE_RULES, FIND_DEPENDENT_RULES, FIND_DEPENDENT_CALCULATED_PROPERTIES, FIND_DEPENDENT_AQL_PROPERTIES, FIND_DEPENDENT_LOG_SOURCE_GROUPS, FIND_DEPENDENT_CUSTOM_PROPERTIES, FIND_DEPENDENT_REPORTS, FIND_DEPENDENT_DASHBOARDS, FIND_DEPENDENT_STORE_AND_FORWARD_POLOCIES, FIND_DEPENDENT_AUTHORIZED_SERVICES, FIND_DEPENDENT_OFFENSE_TYPES, FIND_DEPENDENT_ASSIGNED_OFFENSES, FIND_DEPENDENT_VULNERABILITIES, FIND_DEPENDENT_GROUPS, FIND_DEPENDENT_HISTORICAL_CORRELATION_PROFILES, FIND_DEPENDENT_SECURITY_PROFILES, FIND_DEPENDENT_ARIEL_INDEXING, FIND_DEPENDENT_DOMAIN, FIND_DEPENDENT_NAMED_SERVICES, FIND_DEPENDENT_FORWARDING_PROFILE>"
}
]
}
</code></pre>
</section>
</div>
<aside role="complementary" aria-labelledby="api-17.0--analytics-building_blocks-building_block_dependent_tasks-task_id-POST__title__1"><nav role="navigation">
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="c_rest_api_version170_analytics_intro.html" title="Use the references for REST API 17.0 analytics endpoints.">analytics endpoints</a></div>
</div>
</nav></aside></article></main></body></html>