You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by jo...@apache.org on 2015/12/12 01:55:23 UTC
svn commit: r1719609 [12/12] - in /nifi/site/trunk/docs/nifi-docs: ./
components/org.apache.nifi.couchbase.CouchbaseClusterService/
components/org.apache.nifi.hbase.GetHBase/
components/org.apache.nifi.hbase.HBase_1_1_2_ClientService/
components/org.ap...
Modified: nifi/site/trunk/docs/nifi-docs/rest-api/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/rest-api/index.html?rev=1719609&r1=1719608&r2=1719609&view=diff
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/rest-api/index.html (original)
+++ nifi/site/trunk/docs/nifi-docs/rest-api/index.html Sat Dec 12 00:55:22 2015
@@ -15,7 +15,7 @@
-->
<html>
<head>
- <title>NiFi Rest Api-0.3.0</title>
+ <title>NiFi Rest Api-0.4.0</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<link rel="shortcut icon" href="images/nifi16.ico"/>
<script type="text/javascript" src="../../nifi/js/jquery/jquery-2.1.1.min.js"></script>
@@ -460,7 +460,7 @@
<div class="header">
<img class="logo" src="images/bgNifiLogo.png" alt="NiFi Logo"/>
<div class="title">/nifi-api</div>
- <div class="sub-title">NiFi Rest Api 0.3.0</div>
+ <div class="sub-title">NiFi Rest Api 0.4.0</div>
<div class="clear"></div>
</div>
<div class="clear"></div>
@@ -592,23 +592,19 @@
<div class="endpoints">
- <span class="path hidden">/cluster</span>
+ <span class="path hidden">/access</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets the contents of the cluster</div>
+ <div class="summary">Gets the status the client's access</div>
<div class="clear"></div>
</div>
<div class="operation hidden">
- <div class="description">
- Returns the contents of the cluster including all nodes and their status.
- </div>
-
<div class="title">Request</div>
<div class="mediatypes details">
@@ -665,7 +661,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterEntity</a>
+ <a class="type-link" href="javascript:void(0);">AccessStatusEntity</a>
</td>
<td>successful operation</td>
@@ -688,7 +684,7 @@
string
</td>
- <td>Client could not be authenticated.</td>
+ <td>Unable to determine access status because the client could not be authenticated.</td>
</tr>
<tr>
@@ -698,7 +694,7 @@
string
</td>
- <td>Client is not authorized to make this request.</td>
+ <td>Unable to determine access status because the client is not authorized to make this request.</td>
</tr>
<tr>
@@ -708,7 +704,17 @@
string
</td>
- <td>The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.</td>
+ <td>Unable to determine access status because NiFi is not in the appropriate state.</td>
+ </tr>
+
+ <tr>
+ <td>500</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Unable to determine access status because an unexpected error occurred.</td>
</tr>
</tbody>
@@ -716,17 +722,95 @@
<div class="title">Authorization</div>
<div class="authorization details">
+ </div>
+</div>
+ </div>
+
+
+
+</div>
- <div>Read Only</div>
+
+<div class="endpoints">
+ <span class="path hidden">/access/config</span>
+
+
+ <div class="endpoint get">
+ <div class="operation-handle">
+ <div class="method">GET</div>
+ <div class="path mono"></div>
+ <div class="summary">Retrieves the access configuration for this NiFi</div>
+ <div class="clear"></div>
+ </div>
+<div class="operation hidden">
+
+ <div class="title">Request</div>
+ <div class="mediatypes details">
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
+
+ </div>
+
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Location</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+
+ <tr>
+ <td>clientId</td>
+ <td>query</td>
- <div>DFM</div>
+
+
+ <td>string</td>
+
+
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ </tr>
+
+
+ </tbody>
+ </table>
+
+ <div class="title">Response</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+ </div>
+ <table>
+ <thead>
+ <tr>
+ <th>Status Code</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
- <div>Admin</div>
+ <tr>
+ <td>200</td>
+ <td>
+
+ <a class="type-link" href="javascript:void(0);">AccessConfigurationEntity</a>
+
+ </td>
+ <td>successful operation</td>
+ </tr>
+ </tbody>
+ </table>
+ <div class="title">Authorization</div>
+ <div class="authorization details">
</div>
</div>
@@ -738,14 +822,13 @@
<div class="endpoints">
- <span class="path hidden">/cluster/connections/{id}/status</span>
+ <span class="path hidden">/access/token</span>
-
- <div class="endpoint get">
+ <div class="endpoint post">
<div class="operation-handle">
- <div class="method">GET</div>
+ <div class="method">POST</div>
<div class="path mono"></div>
- <div class="summary">Gets connection status across the cluster</div>
+ <div class="summary">Creates a token for accessing the REST API via username/password</div>
<div class="clear"></div>
</div>
@@ -754,7 +837,7 @@
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/x-www-form-urlencoded</div><div class="clear"></div></div>
</div>
@@ -771,21 +854,21 @@
<tr>
- <td>clientId</td>
- <td>query</td>
+ <td>username</td>
+ <td>formData</td>
- <td>string</td>
+ <td>string </td>
- <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ <td></td>
</tr>
<tr>
- <td>id</td>
- <td>path</td>
+ <td>password</td>
+ <td>formData</td>
@@ -793,7 +876,7 @@
- <td>The connection id</td>
+ <td></td>
</tr>
@@ -803,7 +886,7 @@
<div class="title">Response</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">text/plain</div><div class="clear"></div></div>
</div>
<table>
@@ -820,7 +903,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterConnectionStatusEntity</a>
+
</td>
<td>successful operation</td>
@@ -837,16 +920,6 @@
</tr>
<tr>
- <td>401</td>
- <td>
-
- string
-
- </td>
- <td>Client could not be authenticated.</td>
- </tr>
-
- <tr>
<td>403</td>
<td>
@@ -857,23 +930,23 @@
</tr>
<tr>
- <td>404</td>
+ <td>409</td>
<td>
string
</td>
- <td>The specified resource could not be found.</td>
+ <td>Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login.</td>
</tr>
<tr>
- <td>409</td>
+ <td>500</td>
<td>
string
</td>
- <td>The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.</td>
+ <td>Unable to create access token because an unexpected error occurred.</td>
</tr>
</tbody>
@@ -881,41 +954,34 @@
<div class="title">Authorization</div>
<div class="authorization details">
-
- <div>Read Only</div>
-
-
-
- <div>DFM</div>
-
-
-
- <div>Admin</div>
-
-
</div>
</div>
</div>
+
</div>
<div class="endpoints">
- <span class="path hidden">/cluster/connections/{id}/status/history</span>
+ <span class="path hidden">/cluster</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets connection status history across the cluster</div>
+ <div class="summary">Gets the contents of the cluster</div>
<div class="clear"></div>
</div>
<div class="operation hidden">
+ <div class="description">
+ Returns the contents of the cluster including all nodes and their status.
+ </div>
+
<div class="title">Request</div>
<div class="mediatypes details">
@@ -948,19 +1014,6 @@
<td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
</tr>
- <tr>
- <td>id</td>
- <td>path</td>
-
-
-
- <td>string </td>
-
-
-
- <td>The connection id.</td>
- </tr>
-
</tbody>
</table>
@@ -985,7 +1038,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterEntity</a>
</td>
<td>successful operation</td>
@@ -1022,16 +1075,6 @@
</tr>
<tr>
- <td>404</td>
- <td>
-
- string
-
- </td>
- <td>The specified resource could not be found.</td>
- </tr>
-
- <tr>
<td>409</td>
<td>
@@ -1068,14 +1111,14 @@
<div class="endpoints">
- <span class="path hidden">/cluster/input-ports/{id}/status</span>
+ <span class="path hidden">/cluster/connections/{id}/status</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets input port status across the cluster</div>
+ <div class="summary">Gets connection status across the cluster</div>
<div class="clear"></div>
</div>
@@ -1123,7 +1166,7 @@
- <td>The input port id.</td>
+ <td>The connection id</td>
</tr>
@@ -1150,7 +1193,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterPortStatusEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterConnectionStatusEntity</a>
</td>
<td>successful operation</td>
@@ -1233,14 +1276,14 @@
<div class="endpoints">
- <span class="path hidden">/cluster/nodes/{id}</span>
+ <span class="path hidden">/cluster/connections/{id}/status/history</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets a node in the cluster</div>
+ <div class="summary">Gets connection status history across the cluster</div>
<div class="clear"></div>
</div>
@@ -1288,7 +1331,7 @@
- <td>The node id.</td>
+ <td>The connection id.</td>
</tr>
@@ -1298,7 +1341,7 @@
<div class="title">Response</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div>
</div>
<table>
@@ -1315,7 +1358,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">NodeEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a>
</td>
<td>successful operation</td>
@@ -1381,11 +1424,11 @@
- <div>Data Flow Manager</div>
+ <div>DFM</div>
- <div>Administrator</div>
+ <div>Admin</div>
</div>
@@ -1393,11 +1436,19 @@
</div>
- <div class="endpoint put">
+
+</div>
+
+
+<div class="endpoints">
+ <span class="path hidden">/cluster/input-ports/{id}/status</span>
+
+
+ <div class="endpoint get">
<div class="operation-handle">
- <div class="method">PUT</div>
+ <div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Updates a node in the cluster</div>
+ <div class="summary">Gets input port status across the cluster</div>
<div class="clear"></div>
</div>
@@ -1406,7 +1457,7 @@
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
</div>
@@ -1423,28 +1474,29 @@
<tr>
- <td>id</td>
- <td>path</td>
+ <td>clientId</td>
+ <td>query</td>
- <td>string </td>
+ <td>string</td>
- <td>The node id.</td>
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
</tr>
<tr>
- <td></td>
- <td>body</td>
+ <td>id</td>
+ <td>path</td>
- <td>
- <a class="type-link" href="javascript:void(0);">NodeEntity</a>
- </td>
+
+ <td>string </td>
+
+
- <td>The node configuration. The only configuration that will be honored at this endpoint is the status or primary flag.</td>
+ <td>The input port id.</td>
</tr>
@@ -1454,7 +1506,7 @@
<div class="title">Response</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div>
</div>
<table>
@@ -1471,7 +1523,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">NodeEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterPortStatusEntity</a>
</td>
<td>successful operation</td>
@@ -1533,19 +1585,35 @@
<div class="authorization details">
- <div>Administrator</div>
+ <div>Read Only</div>
- </div>
-</div>
- </div>
-
-
- <div class="endpoint delete">
- <div class="operation-handle">
- <div class="method">DELETE</div>
+
+ <div>DFM</div>
+
+
+
+ <div>Admin</div>
+
+
+ </div>
+</div>
+ </div>
+
+
+
+</div>
+
+
+<div class="endpoints">
+ <span class="path hidden">/cluster/nodes/{id}</span>
+
+
+ <div class="endpoint get">
+ <div class="operation-handle">
+ <div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Removes a node from the cluster</div>
+ <div class="summary">Gets a node in the cluster</div>
<div class="clear"></div>
</div>
@@ -1682,6 +1750,14 @@
<div class="authorization details">
+ <div>Read Only</div>
+
+
+
+ <div>Data Flow Manager</div>
+
+
+
<div>Administrator</div>
@@ -1689,18 +1765,12 @@
</div>
</div>
-</div>
-
-
-<div class="endpoints">
- <span class="path hidden">/cluster/nodes/{id}/status</span>
-
- <div class="endpoint get">
+ <div class="endpoint put">
<div class="operation-handle">
- <div class="method">GET</div>
+ <div class="method">PUT</div>
<div class="path mono"></div>
- <div class="summary">Gets process group status for a node in the cluster</div>
+ <div class="summary">Updates a node in the cluster</div>
<div class="clear"></div>
</div>
@@ -1709,7 +1779,7 @@
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
</div>
@@ -1726,29 +1796,28 @@
<tr>
- <td>clientId</td>
- <td>query</td>
+ <td>id</td>
+ <td>path</td>
- <td>string</td>
+ <td>string </td>
- <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ <td>The node id.</td>
</tr>
<tr>
- <td>id</td>
- <td>path</td>
+ <td></td>
+ <td>body</td>
+ <td>
-
- <td>string </td>
-
-
+ <a class="type-link" href="javascript:void(0);">NodeEntity</a>
+ </td>
- <td>The node id.</td>
+ <td>The node configuration. The only configuration that will be honored at this endpoint is the status or primary flag.</td>
</tr>
@@ -1775,7 +1844,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ProcessGroupStatusEntity</a>
+ <a class="type-link" href="javascript:void(0);">NodeEntity</a>
</td>
<td>successful operation</td>
@@ -1837,14 +1906,6 @@
<div class="authorization details">
- <div>Read Only</div>
-
-
-
- <div>Data Flow Manager</div>
-
-
-
<div>Administrator</div>
@@ -1853,19 +1914,11 @@
</div>
-
-</div>
-
-
-<div class="endpoints">
- <span class="path hidden">/cluster/nodes/{id}/system-diagnostics</span>
-
-
- <div class="endpoint get">
+ <div class="endpoint delete">
<div class="operation-handle">
- <div class="method">GET</div>
+ <div class="method">DELETE</div>
<div class="path mono"></div>
- <div class="summary">Gets system diagnostics for a node in the cluester</div>
+ <div class="summary">Removes a node from the cluster</div>
<div class="clear"></div>
</div>
@@ -1940,7 +1993,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">SystemDiagnosticsEntity</a>
+ <a class="type-link" href="javascript:void(0);">NodeEntity</a>
</td>
<td>successful operation</td>
@@ -2002,14 +2055,6 @@
<div class="authorization details">
- <div>Read Only</div>
-
-
-
- <div>Data Flow Manager</div>
-
-
-
<div>Administrator</div>
@@ -2017,20 +2062,18 @@
</div>
</div>
-
-
</div>
<div class="endpoints">
- <span class="path hidden">/cluster/output-ports/{id}/status</span>
+ <span class="path hidden">/cluster/nodes/{id}/status</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets output port status across the cluster</div>
+ <div class="summary">Gets process group status for a node in the cluster</div>
<div class="clear"></div>
</div>
@@ -2078,7 +2121,7 @@
- <td>The output port id.</td>
+ <td>The node id.</td>
</tr>
@@ -2088,7 +2131,7 @@
<div class="title">Response</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
</div>
<table>
@@ -2105,7 +2148,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterPortStatusEntity</a>
+ <a class="type-link" href="javascript:void(0);">ProcessGroupStatusEntity</a>
</td>
<td>successful operation</td>
@@ -2171,11 +2214,11 @@
- <div>DFM</div>
+ <div>Data Flow Manager</div>
- <div>Admin</div>
+ <div>Administrator</div>
</div>
@@ -2188,14 +2231,14 @@
<div class="endpoints">
- <span class="path hidden">/cluster/process-groups/{id}/status</span>
+ <span class="path hidden">/cluster/nodes/{id}/system-diagnostics</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets process group status across the cluster</div>
+ <div class="summary">Gets system diagnostics for a node in the cluester</div>
<div class="clear"></div>
</div>
@@ -2243,7 +2286,7 @@
- <td>The process group id.</td>
+ <td>The node id.</td>
</tr>
@@ -2253,7 +2296,7 @@
<div class="title">Response</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
</div>
<table>
@@ -2270,7 +2313,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterProcessGroupStatusEntity</a>
+ <a class="type-link" href="javascript:void(0);">SystemDiagnosticsEntity</a>
</td>
<td>successful operation</td>
@@ -2336,11 +2379,11 @@
- <div>DFM</div>
+ <div>Data Flow Manager</div>
- <div>Admin</div>
+ <div>Administrator</div>
</div>
@@ -2353,14 +2396,14 @@
<div class="endpoints">
- <span class="path hidden">/cluster/process-groups/{id}/status/history</span>
+ <span class="path hidden">/cluster/output-ports/{id}/status</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets process group status history across the cluster</div>
+ <div class="summary">Gets output port status across the cluster</div>
<div class="clear"></div>
</div>
@@ -2408,7 +2451,7 @@
- <td>The process group id.</td>
+ <td>The output port id.</td>
</tr>
@@ -2435,7 +2478,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterPortStatusEntity</a>
</td>
<td>successful operation</td>
@@ -2518,14 +2561,14 @@
<div class="endpoints">
- <span class="path hidden">/cluster/processors/{id}</span>
+ <span class="path hidden">/cluster/process-groups/{id}/status</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets the specified processor</div>
+ <div class="summary">Gets process group status across the cluster</div>
<div class="clear"></div>
</div>
@@ -2573,7 +2616,7 @@
- <td>The processor id.</td>
+ <td>The process group id.</td>
</tr>
@@ -2600,7 +2643,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ProcessorEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterProcessGroupStatusEntity</a>
</td>
<td>successful operation</td>
@@ -2678,11 +2721,19 @@
</div>
- <div class="endpoint put">
+
+</div>
+
+
+<div class="endpoints">
+ <span class="path hidden">/cluster/process-groups/{id}/status/history</span>
+
+
+ <div class="endpoint get">
<div class="operation-handle">
- <div class="method">PUT</div>
+ <div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Updates processor annotation data</div>
+ <div class="summary">Gets process group status history across the cluster</div>
<div class="clear"></div>
</div>
@@ -2691,7 +2742,7 @@
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
</div>
@@ -2708,28 +2759,29 @@
<tr>
- <td>id</td>
- <td>path</td>
+ <td>clientId</td>
+ <td>query</td>
- <td>string </td>
+ <td>string</td>
- <td>The processor id.</td>
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
</tr>
<tr>
- <td></td>
- <td>body</td>
+ <td>id</td>
+ <td>path</td>
- <td>
- <a class="type-link" href="javascript:void(0);">ProcessorEntity</a>
- </td>
+
+ <td>string </td>
+
+
- <td>The processor configuration details. The only configuration that will be honored at this endpoint is the processor annontation data.</td>
+ <td>The process group id.</td>
</tr>
@@ -2756,7 +2808,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ProcessorEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a>
</td>
<td>successful operation</td>
@@ -2834,18 +2886,19 @@
</div>
+
</div>
<div class="endpoints">
- <span class="path hidden">/cluster/processors/{id}/status</span>
+ <span class="path hidden">/cluster/processors/{id}</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets the processor status across the cluster</div>
+ <div class="summary">Gets the specified processor</div>
<div class="clear"></div>
</div>
@@ -2893,7 +2946,7 @@
- <td>The processor id</td>
+ <td>The processor id.</td>
</tr>
@@ -2920,7 +2973,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterProcessorStatusEntity</a>
+ <a class="type-link" href="javascript:void(0);">ProcessorEntity</a>
</td>
<td>successful operation</td>
@@ -2998,19 +3051,11 @@
</div>
-
-</div>
-
-
-<div class="endpoints">
- <span class="path hidden">/cluster/processors/{id}/status/history</span>
-
-
- <div class="endpoint get">
+ <div class="endpoint put">
<div class="operation-handle">
- <div class="method">GET</div>
+ <div class="method">PUT</div>
<div class="path mono"></div>
- <div class="summary">Gets processor status history across the cluster</div>
+ <div class="summary">Updates processor annotation data</div>
<div class="clear"></div>
</div>
@@ -3019,7 +3064,7 @@
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
</div>
@@ -3036,29 +3081,28 @@
<tr>
- <td>clientId</td>
- <td>query</td>
+ <td>id</td>
+ <td>path</td>
- <td>string</td>
+ <td>string </td>
- <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ <td>The processor id.</td>
</tr>
<tr>
- <td>id</td>
- <td>path</td>
+ <td></td>
+ <td>body</td>
+ <td>
-
- <td>string </td>
-
-
+ <a class="type-link" href="javascript:void(0);">ProcessorEntity</a>
+ </td>
- <td>The processor id</td>
+ <td>The processor configuration details. The only configuration that will be honored at this endpoint is the processor annontation data.</td>
</tr>
@@ -3085,7 +3129,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a>
+ <a class="type-link" href="javascript:void(0);">ProcessorEntity</a>
</td>
<td>successful operation</td>
@@ -3163,19 +3207,18 @@
</div>
-
</div>
<div class="endpoints">
- <span class="path hidden">/cluster/remote-process-groups/{id}/status</span>
+ <span class="path hidden">/cluster/processors/{id}/status</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets remote process group status across the cluster</div>
+ <div class="summary">Gets the processor status across the cluster</div>
<div class="clear"></div>
</div>
@@ -3223,7 +3266,7 @@
- <td>The remote process group id.</td>
+ <td>The processor id</td>
</tr>
@@ -3250,7 +3293,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterRemoteProcessGroupStatusEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterProcessorStatusEntity</a>
</td>
<td>successful operation</td>
@@ -3333,14 +3376,14 @@
<div class="endpoints">
- <span class="path hidden">/cluster/remote-process-groups/{id}/status/history</span>
+ <span class="path hidden">/cluster/processors/{id}/status/history</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets the remote process group status history across the cluster</div>
+ <div class="summary">Gets processor status history across the cluster</div>
<div class="clear"></div>
</div>
@@ -3388,7 +3431,7 @@
- <td>The remote process group id.</td>
+ <td>The processor id</td>
</tr>
@@ -3498,14 +3541,14 @@
<div class="endpoints">
- <span class="path hidden">/cluster/search-results</span>
+ <span class="path hidden">/cluster/remote-process-groups/{id}/status</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Searches the cluster for a node with the specified address</div>
+ <div class="summary">Gets remote process group status across the cluster</div>
<div class="clear"></div>
</div>
@@ -3531,16 +3574,29 @@
<tr>
- <td>q</td>
+ <td>clientId</td>
<td>query</td>
+ <td>string</td>
+
+
+
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ </tr>
+
+ <tr>
+ <td>id</td>
+ <td>path</td>
+
+
+
<td>string </td>
- <td>Node address to search for.</td>
+ <td>The remote process group id.</td>
</tr>
@@ -3567,7 +3623,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterSearchResultsEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterRemoteProcessGroupStatusEntity</a>
</td>
<td>successful operation</td>
@@ -3650,14 +3706,14 @@
<div class="endpoints">
- <span class="path hidden">/cluster/status</span>
+ <span class="path hidden">/cluster/remote-process-groups/{id}/status/history</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets the status of the cluster</div>
+ <div class="summary">Gets the remote process group status history across the cluster</div>
<div class="clear"></div>
</div>
@@ -3695,6 +3751,19 @@
<td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
</tr>
+ <tr>
+ <td>id</td>
+ <td>path</td>
+
+
+
+ <td>string </td>
+
+
+
+ <td>The remote process group id.</td>
+ </tr>
+
</tbody>
</table>
@@ -3702,7 +3771,7 @@
<div class="title">Response</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div>
</div>
<table>
@@ -3719,7 +3788,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterStatusEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterStatusHistoryEntity</a>
</td>
<td>successful operation</td>
@@ -3756,6 +3825,16 @@
</tr>
<tr>
+ <td>404</td>
+ <td>
+
+ string
+
+ </td>
+ <td>The specified resource could not be found.</td>
+ </tr>
+
+ <tr>
<td>409</td>
<td>
@@ -3792,14 +3871,14 @@
<div class="endpoints">
- <span class="path hidden">/controller</span>
+ <span class="path hidden">/cluster/search-results</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Returns the details about this NiFi necessary to communicate via site to site</div>
+ <div class="summary">Searches the cluster for a node with the specified address</div>
<div class="clear"></div>
</div>
@@ -3825,16 +3904,16 @@
<tr>
- <td>clientId</td>
+ <td>q</td>
<td>query</td>
- <td>string</td>
+ <td>string </td>
- <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ <td>Node address to search for.</td>
</tr>
@@ -3844,7 +3923,7 @@
<div class="title">Response</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/xml, application/json</div><div class="clear"></div></div>
</div>
<table>
@@ -3861,7 +3940,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ControllerEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterSearchResultsEntity</a>
</td>
<td>successful operation</td>
@@ -3898,6 +3977,16 @@
</tr>
<tr>
+ <td>404</td>
+ <td>
+
+ string
+
+ </td>
+ <td>The specified resource could not be found.</td>
+ </tr>
+
+ <tr>
<td>409</td>
<td>
@@ -3913,7 +4002,15 @@
<div class="authorization details">
- <div>NiFi</div>
+ <div>Read Only</div>
+
+
+
+ <div>DFM</div>
+
+
+
+ <div>Admin</div>
</div>
@@ -3926,14 +4023,14 @@
<div class="endpoints">
- <span class="path hidden">/controller/about</span>
+ <span class="path hidden">/cluster/status</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Retrieves details about this NiFi to put in the About dialog</div>
+ <div class="summary">Gets the status of the cluster</div>
<div class="clear"></div>
</div>
@@ -3995,7 +4092,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">AboutEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusterStatusEntity</a>
</td>
<td>successful operation</td>
@@ -4051,11 +4148,11 @@
- <div>Data Flow Manager</div>
+ <div>DFM</div>
- <div>Administrator</div>
+ <div>Admin</div>
</div>
@@ -4068,26 +4165,23 @@
<div class="endpoints">
- <span class="path hidden">/controller/archive</span>
+ <span class="path hidden">/controller</span>
- <div class="endpoint post">
+
+ <div class="endpoint get">
<div class="operation-handle">
- <div class="method">POST</div>
+ <div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Creates a new archive of this NiFi flow configuration</div>
+ <div class="summary">Returns the details about this NiFi necessary to communicate via site to site</div>
<div class="clear"></div>
</div>
<div class="operation hidden">
- <div class="description">
- This POST operation returns a URI that is not representative of the thing that was actually created. The archive that is created cannot be referenced at a later time, therefore there is no corresponding URI. Instead the request URI is returned.
- </div>
-
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/x-www-form-urlencoded</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
</div>
@@ -4104,21 +4198,8 @@
<tr>
- <td>version</td>
- <td>formData</td>
-
-
-
- <td>string</td>
-
-
-
- <td>The revision is used to verify the client is working with the latest version of the flow.</td>
- </tr>
-
- <tr>
<td>clientId</td>
- <td>formData</td>
+ <td>query</td>
@@ -4153,7 +4234,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ProcessGroupEntity</a>
+ <a class="type-link" href="javascript:void(0);">ControllerEntity</a>
</td>
<td>successful operation</td>
@@ -4205,7 +4286,7 @@
<div class="authorization details">
- <div>Data Flow Manager</div>
+ <div>NiFi</div>
</div>
@@ -4214,19 +4295,18 @@
-
</div>
<div class="endpoints">
- <span class="path hidden">/controller/authorities</span>
+ <span class="path hidden">/controller/about</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Retrieves the user details, including the authorities, about the user making the request</div>
+ <div class="summary">Retrieves details about this NiFi to put in the About dialog</div>
<div class="clear"></div>
</div>
@@ -4288,7 +4368,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">AuthorityEntity</a>
+ <a class="type-link" href="javascript:void(0);">AboutEntity</a>
</td>
<td>successful operation</td>
@@ -4361,23 +4441,26 @@
<div class="endpoints">
- <span class="path hidden">/controller/banners</span>
-
+ <span class="path hidden">/controller/archive</span>
- <div class="endpoint get">
+ <div class="endpoint post">
<div class="operation-handle">
- <div class="method">GET</div>
+ <div class="method">POST</div>
<div class="path mono"></div>
- <div class="summary">Retrieves the banners for this NiFi</div>
+ <div class="summary">Creates a new archive of this NiFi flow configuration</div>
<div class="clear"></div>
</div>
<div class="operation hidden">
+ <div class="description">
+ This POST operation returns a URI that is not representative of the thing that was actually created. The archive that is created cannot be referenced at a later time, therefore there is no corresponding URI. Instead the request URI is returned.
+ </div>
+
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/x-www-form-urlencoded</div><div class="clear"></div></div>
</div>
@@ -4394,8 +4477,21 @@
<tr>
+ <td>version</td>
+ <td>formData</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>The revision is used to verify the client is working with the latest version of the flow.</td>
+ </tr>
+
+ <tr>
<td>clientId</td>
- <td>query</td>
+ <td>formData</td>
@@ -4430,7 +4526,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">BannerEntity</a>
+ <a class="type-link" href="javascript:void(0);">ProcessGroupEntity</a>
</td>
<td>successful operation</td>
@@ -4482,35 +4578,28 @@
<div class="authorization details">
- <div>Read Only</div>
-
-
-
<div>Data Flow Manager</div>
-
- <div>Administrator</div>
-
-
</div>
</div>
</div>
+
</div>
<div class="endpoints">
- <span class="path hidden">/controller/bulletin-board</span>
+ <span class="path hidden">/controller/authorities</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets current bulletins</div>
+ <div class="summary">Retrieves the user details, including the authorities, about the user making the request</div>
<div class="clear"></div>
</div>
@@ -4548,73 +4637,149 @@
<td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
</tr>
- <tr>
- <td>after</td>
- <td>query</td>
+
+ </tbody>
+ </table>
+
+ <div class="title">Response</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+
+ </div>
+ <table>
+ <thead>
+ <tr>
+ <th>Status Code</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
-
+ <tr>
+ <td>200</td>
+ <td>
- <td>string</td>
+ <a class="type-link" href="javascript:void(0);">AuthorityEntity</a>
-
-
- <td>Includes bulletins with an id after this value.</td>
- </tr>
-
- <tr>
- <td>sourceName</td>
- <td>query</td>
+ </td>
+ <td>successful operation</td>
+ </tr>
-
+ <tr>
+ <td>400</td>
+ <td>
- <td>string</td>
+ string
-
+ </td>
+ <td>NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.</td>
+ </tr>
- <td>Includes bulletins originating from this sources whose name match this regular expression.</td>
- </tr>
-
- <tr>
- <td>message</td>
- <td>query</td>
+ <tr>
+ <td>401</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Client could not be authenticated.</td>
+ </tr>
-
+ <tr>
+ <td>403</td>
+ <td>
- <td>string</td>
+ string
-
+ </td>
+ <td>Client is not authorized to make this request.</td>
+ </tr>
- <td>Includes bulletins whose message that match this regular expression.</td>
- </tr>
-
- <tr>
- <td>sourceId</td>
- <td>query</td>
-
-
+ <tr>
+ <td>409</td>
+ <td>
- <td>string</td>
+ string
-
+ </td>
+ <td>The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.</td>
+ </tr>
- <td>Includes bulletins originating from this sources whose id match this regular expression.</td>
- </tr>
+ </tbody>
+ </table>
+ <div class="title">Authorization</div>
+ <div class="authorization details">
+
+
+ <div>Read Only</div>
+
+
+
+ <div>Data Flow Manager</div>
+
+
+
+ <div>Administrator</div>
+
+
+
+ <div>Proxy</div>
+
+
+
+ <div>NiFi</div>
+
+
+
+ <div>Provenance</div>
+
+
+ </div>
+</div>
+ </div>
- <tr>
- <td>groupId</td>
- <td>query</td>
+
+
+</div>
-
- <td>string</td>
-
-
+<div class="endpoints">
+ <span class="path hidden">/controller/banners</span>
+
+
+ <div class="endpoint get">
+ <div class="operation-handle">
+ <div class="method">GET</div>
+ <div class="path mono"></div>
+ <div class="summary">Retrieves the banners for this NiFi</div>
+ <div class="clear"></div>
+ </div>
- <td>Includes bulletins originating from this sources whose group id match this regular expression.</td>
- </tr>
+<div class="operation hidden">
+
+ <div class="title">Request</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
+
+ </div>
+
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Location</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>limit</td>
+ <td>clientId</td>
<td>query</td>
@@ -4623,7 +4788,7 @@
- <td>The number of bulletins to limit the response to.</td>
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
</tr>
@@ -4650,7 +4815,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">BulletinBoardEntity</a>
+ <a class="type-link" href="javascript:void(0);">BannerEntity</a>
</td>
<td>successful operation</td>
@@ -4723,14 +4888,14 @@
<div class="endpoints">
- <span class="path hidden">/controller/config</span>
+ <span class="path hidden">/controller/bulletin-board</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Retrieves the configuration for this NiFi</div>
+ <div class="summary">Gets current bulletins</div>
<div class="clear"></div>
</div>
@@ -4768,6 +4933,84 @@
<td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
</tr>
+ <tr>
+ <td>after</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>Includes bulletins with an id after this value.</td>
+ </tr>
+
+ <tr>
+ <td>sourceName</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>Includes bulletins originating from this sources whose name match this regular expression.</td>
+ </tr>
+
+ <tr>
+ <td>message</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>Includes bulletins whose message that match this regular expression.</td>
+ </tr>
+
+ <tr>
+ <td>sourceId</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>Includes bulletins originating from this sources whose id match this regular expression.</td>
+ </tr>
+
+ <tr>
+ <td>groupId</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>Includes bulletins originating from this sources whose group id match this regular expression.</td>
+ </tr>
+
+ <tr>
+ <td>limit</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>The number of bulletins to limit the response to.</td>
+ </tr>
+
</tbody>
</table>
@@ -4792,7 +5035,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ControllerConfigurationEntity</a>
+ <a class="type-link" href="javascript:void(0);">BulletinBoardEntity</a>
</td>
<td>successful operation</td>
@@ -4855,18 +5098,22 @@
<div>Administrator</div>
-
- <div>ROLE_NIFI</div>
-
-
</div>
</div>
</div>
- <div class="endpoint put">
+
+</div>
+
+
+<div class="endpoints">
+ <span class="path hidden">/controller/config</span>
+
+
+ <div class="endpoint get">
<div class="operation-handle">
- <div class="method">PUT</div>
+ <div class="method">GET</div>
<div class="path mono"></div>
<div class="summary">Retrieves the configuration for this NiFi</div>
<div class="clear"></div>
@@ -4877,7 +5124,7 @@
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
</div>
@@ -4894,15 +5141,16 @@
<tr>
- <td></td>
- <td>body</td>
+ <td>clientId</td>
+ <td>query</td>
- <td>
- <a class="type-link" href="javascript:void(0);">ControllerConfigurationEntity</a>
- </td>
+
+ <td>string</td>
+
+
- <td>The controller configuration.</td>
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
</tr>
@@ -4981,26 +5229,31 @@
<div class="authorization details">
+ <div>Read Only</div>
+
+
+
<div>Data Flow Manager</div>
+
+ <div>Administrator</div>
+
+
+
+ <div>ROLE_NIFI</div>
+
+
</div>
</div>
</div>
-</div>
-
-
-<div class="endpoints">
- <span class="path hidden">/controller/controller-service-types</span>
-
-
- <div class="endpoint get">
+ <div class="endpoint put">
<div class="operation-handle">
- <div class="method">GET</div>
+ <div class="method">PUT</div>
<div class="path mono"></div>
- <div class="summary">Retrieves the types of controller services that this NiFi supports</div>
+ <div class="summary">Retrieves the configuration for this NiFi</div>
<div class="clear"></div>
</div>
@@ -5009,7 +5262,7 @@
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
</div>
@@ -5026,22 +5279,154 @@
<tr>
- <td>clientId</td>
- <td>query</td>
+ <td></td>
+ <td>body</td>
+ <td>
-
- <td>string</td>
-
-
+ <a class="type-link" href="javascript:void(0);">ControllerConfigurationEntity</a>
+ </td>
- <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ <td>The controller configuration.</td>
</tr>
- <tr>
- <td>serviceType</td>
- <td>query</td>
-
+
+ </tbody>
+ </table>
+
+ <div class="title">Response</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+
+ </div>
+ <table>
+ <thead>
+ <tr>
+ <th>Status Code</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>200</td>
+ <td>
+
+ <a class="type-link" href="javascript:void(0);">ControllerConfigurationEntity</a>
+
+ </td>
+ <td>successful operation</td>
+ </tr>
+
+ <tr>
+ <td>400</td>
+ <td>
+
+ string
+
+ </td>
+ <td>NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.</td>
+ </tr>
+
+ <tr>
+ <td>401</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Client could not be authenticated.</td>
+ </tr>
+
+ <tr>
+ <td>403</td>
+ <td>
+
+ string
+
+ </td>
+ <td>Client is not authorized to make this request.</td>
+ </tr>
+
+ <tr>
+ <td>409</td>
+ <td>
+
+ string
+
+ </td>
+ <td>The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <div class="title">Authorization</div>
+ <div class="authorization details">
+
+
+ <div>Data Flow Manager</div>
+
+
+ </div>
+</div>
+ </div>
+
+
+</div>
+
+
+<div class="endpoints">
+ <span class="path hidden">/controller/controller-service-types</span>
+
+
+ <div class="endpoint get">
+ <div class="operation-handle">
+ <div class="method">GET</div>
+ <div class="path mono"></div>
+ <div class="summary">Retrieves the types of controller services that this NiFi supports</div>
+ <div class="clear"></div>
+ </div>
+
+<div class="operation hidden">
+
+ <div class="title">Request</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
+
+ </div>
+
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Location</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+
+ <tr>
+ <td>clientId</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ </tr>
+
+ <tr>
+ <td>serviceType</td>
+ <td>query</td>
+
<td>string </td>
@@ -7851,6 +8236,96 @@
<div class="endpoints">
+ <span class="path hidden">/controller/identity</span>
+
+
+ <div class="endpoint get">
+ <div class="operation-handle">
+ <div class="method">GET</div>
+ <div class="path mono"></div>
+ <div class="summary">Retrieves the user identity of the user making the request</div>
+ <div class="clear"></div>
+ </div>
+
+<div class="operation hidden">
+
+ <div class="title">Request</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
+
+ </div>
+
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Location</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+
+ <tr>
+ <td>clientId</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ </tr>
+
+
+ </tbody>
+ </table>
+
+ <div class="title">Response</div>
+ <div class="mediatypes details">
+
+ <div class="mediatype"><div class="title">produces:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+
+ </div>
+ <table>
+ <thead>
+ <tr>
+ <th>Status Code</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>200</td>
+ <td>
+
+ <a class="type-link" href="javascript:void(0);">IdentityEntity</a>
+
+ </td>
+ <td>successful operation</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <div class="title">Authorization</div>
+ <div class="authorization details">
+
+ </div>
+</div>
+ </div>
+
+
+
+</div>
+
+
+<div class="endpoints">
<span class="path hidden">/controller/prioritizers</span>
@@ -8655,14 +9130,16 @@
<div class="endpoints">
- <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{id}</span>
+ <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{connection-id}/contents</span>
- <div class="endpoint get">
+
+
+ <div class="endpoint delete">
<div class="operation-handle">
- <div class="method">GET</div>
+ <div class="method">DELETE</div>
<div class="path mono"></div>
- <div class="summary">Gets a connection</div>
+ <div class="summary">Drops the contents of the queue in this connection.</div>
<div class="clear"></div>
</div>
@@ -8701,7 +9178,7 @@
</tr>
<tr>
- <td>id</td>
+ <td>connection-id</td>
<td>path</td>
@@ -8750,7 +9227,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ConnectionEntity</a>
+ <a class="type-link" href="javascript:void(0);">DropRequestEntity</a>
</td>
<td>successful operation</td>
@@ -8812,27 +9289,25 @@
<div class="authorization details">
- <div>Read Only</div>
-
-
-
<div>Data Flow Manager</div>
-
- <div>Administrator</div>
-
-
</div>
</div>
</div>
+</div>
+
+
+<div class="endpoints">
+ <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{connection-id}/drop-requests/{drop-request-id}</span>
+
- <div class="endpoint put">
+ <div class="endpoint get">
<div class="operation-handle">
- <div class="method">PUT</div>
+ <div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Updates a connection</div>
+ <div class="summary">Gets the current status of a drop request for the specified connection.</div>
<div class="clear"></div>
</div>
@@ -8841,7 +9316,7 @@
<div class="title">Request</div>
<div class="mediatypes details">
- <div class="mediatype"><div class="title">consumes:</div><div class="mono">application/json, application/xml</div><div class="clear"></div></div>
+ <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div>
</div>
@@ -8858,8 +9333,21 @@
<tr>
- <td>id</td>
- <td>path</td>
+ <td>clientId</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ </tr>
+
+ <tr>
+ <td>connection-id</td>
+ <td>path</td>
@@ -8871,15 +9359,16 @@
</tr>
<tr>
- <td></td>
- <td>body</td>
+ <td>drop-request-id</td>
+ <td>path</td>
- <td>
- <a class="type-link" href="javascript:void(0);">ConnectionEntity</a>
- </td>
+
+ <td>string </td>
+
+
- <td>The connection configuration details.</td>
+ <td>The drop request id.</td>
</tr>
<tr>
@@ -8919,7 +9408,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ConnectionEntity</a>
+ <a class="type-link" href="javascript:void(0);">DropRequestEntity</a>
</td>
<td>successful operation</td>
@@ -8989,11 +9478,12 @@
</div>
+
<div class="endpoint delete">
<div class="operation-handle">
<div class="method">DELETE</div>
<div class="path mono"></div>
- <div class="summary">Deletes a connection</div>
+ <div class="summary">Cancels and/or removes a request drop of the contents in this connection.</div>
<div class="clear"></div>
</div>
@@ -9019,7 +9509,7 @@
<tr>
- <td>version</td>
+ <td>clientId</td>
<td>query</td>
@@ -9028,24 +9518,24 @@
- <td>The revision is used to verify the client is working with the latest version of the flow.</td>
+ <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
</tr>
<tr>
- <td>clientId</td>
- <td>query</td>
+ <td>connection-id</td>
+ <td>path</td>
- <td>string</td>
+ <td>string </td>
- <td>If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.</td>
+ <td>The connection id.</td>
</tr>
<tr>
- <td>id</td>
+ <td>drop-request-id</td>
<td>path</td>
@@ -9054,7 +9544,7 @@
- <td>The connection id.</td>
+ <td>The drop request id.</td>
</tr>
<tr>
@@ -9094,7 +9584,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ConnectionEntity</a>
+ <a class="type-link" href="javascript:void(0);">DropRequestEntity</a>
</td>
<td>successful operation</td>
@@ -9167,14 +9657,14 @@
<div class="endpoints">
- <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{id}/status/history</span>
+ <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{id}</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets the status history for a connection</div>
+ <div class="summary">Gets a connection</div>
<div class="clear"></div>
</div>
@@ -9262,7 +9752,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">StatusHistoryEntity</a>
+ <a class="type-link" href="javascript:void(0);">ConnectionEntity</a>
</td>
<td>successful operation</td>
@@ -9340,18 +9830,11 @@
</div>
-
-</div>
-
-
-<div class="endpoints">
- <span class="path hidden">/controller/process-groups/{process-group-id}/funnels</span>
-
- <div class="endpoint post">
+ <div class="endpoint put">
<div class="operation-handle">
- <div class="method">POST</div>
+ <div class="method">PUT</div>
<div class="path mono"></div>
- <div class="summary">Creates a funnel</div>
+ <div class="summary">Updates a connection</div>
<div class="clear"></div>
</div>
@@ -9377,15 +9860,28 @@
<tr>
+ <td>id</td>
+ <td>path</td>
+
+
+
+ <td>string </td>
+
+
+
+ <td>The connection id.</td>
+ </tr>
+
+ <tr>
<td></td>
<td>body</td>
<td>
- <a class="type-link" href="javascript:void(0);">FunnelEntity</a>
+ <a class="type-link" href="javascript:void(0);">ConnectionEntity</a>
</td>
- <td>The funnel configuration details.</td>
+ <td>The connection configuration details.</td>
</tr>
<tr>
@@ -9425,7 +9921,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">FunnelEntity</a>
+ <a class="type-link" href="javascript:void(0);">ConnectionEntity</a>
</td>
<td>successful operation</td>
@@ -9495,11 +9991,11 @@
</div>
- <div class="endpoint get">
+ <div class="endpoint delete">
<div class="operation-handle">
- <div class="method">GET</div>
+ <div class="method">DELETE</div>
<div class="path mono"></div>
- <div class="summary">Gets all funnels</div>
+ <div class="summary">Deletes a connection</div>
<div class="clear"></div>
</div>
@@ -9525,6 +10021,19 @@
<tr>
+ <td>version</td>
+ <td>query</td>
+
+
+
+ <td>string</td>
+
+
+
+ <td>The revision is used to verify the client is working with the latest version of the flow.</td>
+ </tr>
+
+ <tr>
<td>clientId</td>
<td>query</td>
@@ -9538,6 +10047,19 @@
</tr>
<tr>
+ <td>id</td>
+ <td>path</td>
+
+
+
+ <td>string </td>
+
+
+
+ <td>The connection id.</td>
+ </tr>
+
+ <tr>
<td>process-group-id</td>
<td>path</td>
@@ -9574,7 +10096,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">FunnelsEntity</a>
+ <a class="type-link" href="javascript:void(0);">ConnectionEntity</a>
</td>
<td>successful operation</td>
@@ -9636,35 +10158,25 @@
<div class="authorization details">
- <div>Read Only</div>
-
-
-
<div>Data Flow Manager</div>
-
- <div>Administrator</div>
-
-
</div>
</div>
</div>
-
-
</div>
<div class="endpoints">
- <span class="path hidden">/controller/process-groups/{process-group-id}/funnels/{id}</span>
+ <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{id}/status/history</span>
<div class="endpoint get">
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets a funnel</div>
+ <div class="summary">Gets the status history for a connection</div>
<div class="clear"></div>
</div>
@@ -9712,7 +10224,7 @@
- <td>The funnel id.</td>
+ <td>The connection id.</td>
</tr>
<tr>
@@ -9752,7 +10264,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">FunnelEntity</a>
+ <a class="type-link" href="javascript:void(0);">StatusHistoryEntity</a>
</td>
<td>successful operation</td>
@@ -9830,11 +10342,18 @@
</div>
- <div class="endpoint put">
+
+</div>
+
+
+<div class="endpoints">
+ <span class="path hidden">/controller/process-groups/{process-group-id}/funnels</span>
+
+ <div class="endpoint post">
<div class="operation-handle">
- <div class="method">PUT</div>
+ <div class="method">POST</div>
<div class="path mono"></div>
- <div class="summary">Updates a funnel</div>
[... 10096 lines stripped ...]