Author: joewitt
Date: Tue Nov 29 12:08:07 2016
New Revision: 1771893
URL: http://svn.apache.org/viewvc?rev=1771893&view=rev
Log:
NIFI-3100
Modified:
nifi/site/trunk/docs/nifi-docs/rest-api/index.html
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=1771893&r1=1771892&r2=1771893&view=diff
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/rest-api/index.html (original)
+++ nifi/site/trunk/docs/nifi-docs/rest-api/index.html Tue Nov 29 12:08:07 2016
@@ -15,7 +15,7 @@
-->
<html>
<head>
- <title>NiFi Rest Api-1.0.0</title>
+ <title>NiFi Rest Api-1.1.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>
@@ -470,7 +470,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 1.0.0</div>
+ <div class="sub-title">NiFi Rest Api 1.1.0</div>
<div class="clear"></div>
</div>
<div class="clear"></div>
@@ -1648,7 +1648,7 @@
- <td>string</td>
+ <td>string </td>
@@ -1661,7 +1661,7 @@
- <td>string</td>
+ <td>string </td>
@@ -2108,7 +2108,7 @@
- <td>string</td>
+ <td>string </td>
@@ -2121,7 +2121,7 @@
- <td>string</td>
+ <td>string </td>
@@ -3919,7 +3919,7 @@
- <td>string</td>
+ <td>string </td>
@@ -4348,7 +4348,7 @@
- <td></td>
+ <td>The id of the counter.</td>
</tr>
@@ -5377,7 +5377,7 @@
<td>200</td>
<td>
- string
+ <a class="type-link" href="javascript:void(0);">StreamingOutput</a>
</td>
<td>There is no flow file to return.</td>
@@ -5879,7 +5879,7 @@
- <td>string</td>
+ <td>string </td>
@@ -5892,7 +5892,7 @@
- <td>string</td>
+ <td>string </td>
@@ -5905,7 +5905,7 @@
- <td>string</td>
+ <td>string </td>
@@ -5918,7 +5918,7 @@
- <td>string</td>
+ <td>string </td>
@@ -5931,7 +5931,7 @@
- <td>string</td>
+ <td>string </td>
@@ -5944,7 +5944,7 @@
- <td>string</td>
+ <td>string </td>
@@ -6306,7 +6306,7 @@
<div class="operation-handle">
<div class="method">GET</div>
<div class="path mono"></div>
- <div class="summary">Gets the current status of this NiFi</div>
+ <div class="summary">The cluster summary for this NiFi</div>
<div class="clear"></div>
</div>
@@ -6341,7 +6341,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ControllerStatusEntity</a>
+ <a class="type-link" href="javascript:void(0);">ClusteSummaryEntity</a>
</td>
<td>successful operation</td>
@@ -7310,7 +7310,7 @@
- <td>string</td>
+ <td>string </td>
@@ -7323,7 +7323,7 @@
- <td>string</td>
+ <td>string </td>
@@ -7362,7 +7362,7 @@
- <td>string</td>
+ <td>string </td>
@@ -7375,7 +7375,7 @@
- <td>string</td>
+ <td>string </td>
@@ -7691,7 +7691,7 @@
- <td>string</td>
+ <td>string </td>
@@ -10974,7 +10974,7 @@
- <td>string</td>
+ <td>string </td>
@@ -11890,7 +11890,7 @@
- <td>string</td>
+ <td>string </td>
@@ -11903,7 +11903,7 @@
- <td>string</td>
+ <td>string </td>
@@ -12342,7 +12342,7 @@
- <td>string</td>
+ <td>string </td>
@@ -12355,7 +12355,7 @@
- <td>string</td>
+ <td>string </td>
@@ -12662,7 +12662,7 @@
<a class="type-link" href="javascript:void(0);">LabelEntity</a>
</td>
- <td>The label configuraiton details.</td>
+ <td>The label configuration details.</td>
</tr>
@@ -12794,7 +12794,7 @@
- <td>string</td>
+ <td>string </td>
@@ -12807,7 +12807,7 @@
- <td>string</td>
+ <td>string </td>
@@ -13246,7 +13246,7 @@
- <td>string</td>
+ <td>string </td>
@@ -13259,7 +13259,7 @@
- <td>string</td>
+ <td>string </td>
@@ -14002,7 +14002,7 @@
- <td>string</td>
+ <td>string </td>
@@ -14015,7 +14015,7 @@
- <td>string</td>
+ <td>string </td>
@@ -14454,7 +14454,7 @@
- <td>string</td>
+ <td>string </td>
@@ -14467,7 +14467,7 @@
- <td>string</td>
+ <td>string </td>
@@ -18165,7 +18165,7 @@
- <td>string</td>
+ <td>string </td>
@@ -18178,7 +18178,7 @@
- <td>string</td>
+ <td>string </td>
@@ -18333,7 +18333,7 @@
- <td>string</td>
+ <td>string </td>
@@ -19092,7 +19092,7 @@
- <td>string</td>
+ <td>string </td>
@@ -19249,7 +19249,7 @@
- <td>string</td>
+ <td>string </td>
@@ -19396,7 +19396,7 @@
- <td>string</td>
+ <td>string </td>
@@ -20690,7 +20690,7 @@
- <td>string</td>
+ <td>string </td>
@@ -20703,7 +20703,7 @@
- <td>string</td>
+ <td>string </td>
@@ -21492,7 +21492,7 @@
- <td>string</td>
+ <td>string </td>
@@ -21505,7 +21505,7 @@
- <td>string</td>
+ <td>string </td>
@@ -23228,7 +23228,7 @@
<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">Searches for a tenant with the specified identity</div>
<div class="clear"></div>
</div>
@@ -23267,7 +23267,7 @@
- <td>Node address to search for.</td>
+ <td>Identity to search for.</td>
</tr>
@@ -23294,7 +23294,7 @@
<td>200</td>
<td>
- <a class="type-link" href="javascript:void(0);">ClusterSearchResultsEntity</a>
+ <a class="type-link" href="javascript:void(0);">TenantsEntity</a>
</td>
<td>successful operation</td>
@@ -23962,7 +23962,7 @@
- <td>string</td>
+ <td>string </td>
@@ -23975,7 +23975,7 @@
- <td>string</td>
+ <td>string </td>
@@ -24685,7 +24685,7 @@
- <td>string</td>
+ <td>string </td>
@@ -24698,7 +24698,7 @@
- <td>string</td>
+ <td>string </td>
@@ -24897,7 +24897,7 @@
- string (date-time)
+ string
</td>
@@ -24907,6 +24907,70 @@
This property is read only.</td>
</tr>
+ <tr>
+ <td>buildTag</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Build tag
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>buildRevision</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Build revision or commit hash
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>buildBranch</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Build branch
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>buildTimestamp</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Build timestamp
+
+ </td>
+ </tr>
+
</table>
<h4>Example JSON</h4>
<code class="example"><span class="open-object">{
@@ -24915,6 +24979,10 @@
"uri": "value"<span class="comma">,</span>
"contentViewerUrl": "value"<span class="comma">,</span>
"timezone": "value"<span class="comma">,</span>
+ "buildTag": "value"<span class="comma">,</span>
+ "buildRevision": "value"<span class="comma">,</span>
+ "buildBranch": "value"<span class="comma">,</span>
+ "buildTimestamp": "value"<span class="comma">,</span>
}</span></code>
</div>
<div class="close">Close</div>
@@ -25128,6 +25196,22 @@
</tr>
<tr>
+ <td>componentReference</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">ComponentReferenceEntity</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>Component this policy references if applicable.
+
+ </td>
+ </tr>
+
+ <tr>
<td>users</td>
<td>
@@ -25167,6 +25251,7 @@
"position": <span class="nested collapsed"><span class="nested-id hidden">PositionDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
"resource": "value"<span class="comma">,</span>
"action": "value"<span class="comma">,</span>
+ "componentReference": <span class="nested collapsed"><span class="nested-id hidden">ComponentReferenceEntity</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
"users": [<span class="nested collapsed"><span class="nested-id hidden">TenantEntity</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
"userGroups": [<span class="nested collapsed"><span class="nested-id hidden">TenantEntity</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
}</span></code>
@@ -25289,12 +25374,12 @@
- string (date-time)
+ string
</td>
<td>optional</td>
- <td>
+ <td>When this content was generated.
</td>
</tr>
@@ -25424,6 +25509,22 @@
</td>
</tr>
+ <tr>
+ <td>componentReference</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">ComponentReferenceEntity</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>Component this policy references if applicable.
+
+ </td>
+ </tr>
+
</table>
<h4>Example JSON</h4>
<code class="example"><span class="open-object">{
@@ -25432,6 +25533,7 @@
"position": <span class="nested collapsed"><span class="nested-id hidden">PositionDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
"resource": "value"<span class="comma">,</span>
"action": "value"<span class="comma">,</span>
+ "componentReference": <span class="nested collapsed"><span class="nested-id hidden">ComponentReferenceEntity</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
}</span></code>
</div>
<div class="close">Close</div>
@@ -25738,7 +25840,7 @@
- string (date-time)
+ string
</td>
@@ -25917,12 +26019,12 @@
- string (date-time)
+ string
</td>
<td>optional</td>
- <td>
+ <td>The timestamp of the action.
</td>
</tr>
@@ -26315,7 +26417,7 @@
- string (date-time)
+ string
</td>
@@ -26429,7 +26531,7 @@
</td>
<td>optional</td>
- <td>The catagory of this bulletin.
+ <td>The category of this bulletin.
</td>
</tr>
@@ -26520,7 +26622,7 @@
- string (date-time)
+ string
</td>
@@ -26614,12 +26716,12 @@
- string (date-time)
+ string
</td>
<td>optional</td>
- <td>
+ <td>When this bulletin was generated.
</td>
</tr>
@@ -26689,6 +26791,44 @@
</div>
+<div id="ClusteSummaryEntity" class="type hidden">
+ <h3>ClusteSummaryEntity</h3>
+ <div class="type-container">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>clusterSummary</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">ClusterSummaryDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>
+
+ </td>
+ </tr>
+
+ </table>
+ <h4>Example JSON</h4>
+ <code class="example"><span class="open-object">{
+ "clusterSummary": <span class="nested collapsed"><span class="nested-id hidden">ClusterSummaryDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
+}</span></code>
+ </div>
+ <div class="close">Close</div>
+ <div class="clear"></div>
+</div>
+
+
<div id="ClusterDTO" class="type hidden">
<h3>ClusterDTO</h3>
<div class="type-container">
@@ -26722,7 +26862,7 @@
- string (date-time)
+ string
</td>
@@ -26820,6 +26960,112 @@
</div>
+<div id="ClusterSummaryDTO" class="type hidden">
+ <h3>ClusterSummaryDTO</h3>
+ <div class="type-container">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>connectedNodes</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>When clustered, reports the number of nodes connected vs the number of nodes in the cluster.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>connectedNodeCount</td>
+ <td>
+
+
+
+ integer (int32)
+
+
+ </td>
+ <td>optional</td>
+ <td>The number of nodes that are currently connected to the cluster
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>totalNodeCount</td>
+ <td>
+
+
+
+ integer (int32)
+
+
+ </td>
+ <td>optional</td>
+ <td>The number of nodes in the cluster, regardless of whether or not they are connected
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>clustered</td>
+ <td>
+
+
+
+ boolean
+
+
+ </td>
+ <td>optional</td>
+ <td>Whether this NiFi instance is clustered.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>connectedToCluster</td>
+ <td>
+
+
+
+ boolean
+
+
+ </td>
+ <td>optional</td>
+ <td>Whether this NiFi instance is connected to a cluster.
+
+ </td>
+ </tr>
+
+ </table>
+ <h4>Example JSON</h4>
+ <code class="example"><span class="open-object">{
+ "connectedNodes": "value"<span class="comma">,</span>
+ "connectedNodeCount": 0<span class="comma">,</span>
+ "totalNodeCount": 0<span class="comma">,</span>
+ "clustered": true<span class="comma">,</span>
+ "connectedToCluster": true<span class="comma">,</span>
+}</span></code>
+ </div>
+ <div class="close">Close</div>
+ <div class="clear"></div>
+</div>
+
+
<div id="ComponentDetailsDTO" class="type hidden">
<h3>ComponentDetailsDTO</h3>
<div class="type-container">
@@ -26936,6 +27182,252 @@
</div>
+<div id="ComponentReferenceDTO" class="type hidden">
+ <h3>ComponentReferenceDTO</h3>
+ <div class="type-container">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>id</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>The id of the component.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>parentGroupId</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>The id of parent process group of this component if applicable.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>position</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">PositionDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>The position of this component in the UI if applicable.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>name</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>The name of the component.
+
+ </td>
+ </tr>
+
+ </table>
+ <h4>Example JSON</h4>
+ <code class="example"><span class="open-object">{
+ "id": "value"<span class="comma">,</span>
+ "parentGroupId": "value"<span class="comma">,</span>
+ "position": <span class="nested collapsed"><span class="nested-id hidden">PositionDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
+ "name": "value"<span class="comma">,</span>
+}</span></code>
+ </div>
+ <div class="close">Close</div>
+ <div class="clear"></div>
+</div>
+
+
+<div id="ComponentReferenceEntity" class="type hidden">
+ <h3>ComponentReferenceEntity</h3>
+ <div class="type-container">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>revision</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">RevisionDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>id</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>The id of the component.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>uri</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>The URI for futures requests to the component.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>position</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">PositionDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>The position of this component in the UI if applicable.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>permissions</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">PermissionsDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>The permissions for this component.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>bulletins</td>
+ <td>
+
+
+ array[<a class="type-link" href="javascript:void(0);">BulletinEntity</a>]
+
+
+
+ </td>
+ <td>optional</td>
+ <td>The bulletins for this component.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>parentGroupId</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>The id of parent process group of this component if applicable.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>component</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">ComponentReferenceDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>
+
+ </td>
+ </tr>
+
+ </table>
+ <h4>Example JSON</h4>
+ <code class="example"><span class="open-object">{
+ "revision": <span class="nested collapsed"><span class="nested-id hidden">RevisionDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
+ "id": "value"<span class="comma">,</span>
+ "uri": "value"<span class="comma">,</span>
+ "position": <span class="nested collapsed"><span class="nested-id hidden">PositionDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
+ "permissions": <span class="nested collapsed"><span class="nested-id hidden">PermissionsDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
+ "bulletins": [<span class="nested collapsed"><span class="nested-id hidden">BulletinEntity</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
+ "parentGroupId": "value"<span class="comma">,</span>
+ "component": <span class="nested collapsed"><span class="nested-id hidden">ComponentReferenceDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
+}</span></code>
+ </div>
+ <div class="close">Close</div>
+ <div class="clear"></div>
+</div>
+
+
<div id="ComponentSearchResultDTO" class="type hidden">
<h3>ComponentSearchResultDTO</h3>
<div class="type-container">
@@ -27922,7 +28414,7 @@
- string (date-time)
+ string
</td>
@@ -28402,6 +28894,38 @@
</td>
</tr>
+ <tr>
+ <td>percentUseCount</td>
+ <td>
+
+
+
+ integer (int32)
+
+
+ </td>
+ <td>optional</td>
+ <td>Connection percent use regarding queued flow files count and backpressure threshold if configured.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>percentUseBytes</td>
+ <td>
+
+
+
+ integer (int32)
+
+
+ </td>
+ <td>optional</td>
+ <td>Connection percent use regarding queued flow files size and backpressure threshold if configured.
+
+ </td>
+ </tr>
+
</table>
<h4>Example JSON</h4>
<code class="example"><span class="open-object">{
@@ -28423,6 +28947,8 @@
"queued": "value"<span class="comma">,</span>
"queuedSize": "value"<span class="comma">,</span>
"queuedCount": "value"<span class="comma">,</span>
+ "percentUseCount": 0<span class="comma">,</span>
+ "percentUseBytes": 0<span class="comma">,</span>
}</span></code>
</div>
<div class="close">Close</div>
@@ -28634,7 +29160,7 @@
</td>
<td>optional</td>
- <td>The maimum number of timer driven threads the NiFi has available.
+ <td>The maximum number of timer driven threads the NiFi has available.
</td>
</tr>
@@ -28650,7 +29176,7 @@
</td>
<td>optional</td>
- <td>The maximum number of event driven threads the NiFi has avaiable.
+ <td>The maximum number of event driven threads the NiFi has available.
</td>
</tr>
@@ -28889,7 +29415,7 @@
</td>
<td>optional</td>
- <td>The number of inactive remote porst contained in the NiFi.
+ <td>The number of inactive remote ports contained in the NiFi.
</td>
</tr>
@@ -29227,6 +29753,22 @@
</tr>
<tr>
+ <td>restricted</td>
+ <td>
+
+
+
+ boolean
+
+
+ </td>
+ <td>optional</td>
+ <td>Whether the controller service requires elevated privileges.
+
+ </td>
+ </tr>
+
+ <tr>
<td>properties</td>
<td>
@@ -29285,7 +29827,7 @@
</td>
<td>optional</td>
- <td>The annontation for the controller service. This is how the custom UI relays configuration to the controller service.
+ <td>The annotation for the controller service. This is how the custom UI relays configuration to the controller service.
</td>
</tr>
@@ -29333,6 +29875,7 @@
"comments": "value"<span class="comma">,</span>
"state": "value"<span class="comma">,</span>
"persistsState": true<span class="comma">,</span>
+ "restricted": true<span class="comma">,</span>
"properties": <span class="open-object">{
"name": "value"
}</span><span class="comma">,</span>
@@ -29608,7 +30151,7 @@
</td>
<td>optional</td>
- <td>The descriptors for the componet properties.
+ <td>The descriptors for the component properties.
</td>
</tr>
@@ -29688,7 +30231,7 @@
</td>
<td>optional</td>
- <td>If the referencing component represents a controller service, these are the components that referenc it.
+ <td>If the referencing component represents a controller service, these are the components that reference it.
</td>
</tr>
@@ -29952,7 +30495,7 @@
- string (date-time)
+ string
</td>
@@ -30028,7 +30571,7 @@
</td>
<td>optional</td>
- <td>The number of flowfilew queued in the NiFi.
+ <td>The number of flowfiles queued in the NiFi.
</td>
</tr>
@@ -30545,7 +31088,7 @@
- string (date-time)
+ string
</td>
@@ -30778,6 +31321,38 @@
</td>
</tr>
+ <tr>
+ <td>systemPermissions</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">PermissionsDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>Permissions for accessing system.
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>restrictedComponentsPermissions</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">PermissionsDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>Permissions for accessing restricted components. Note: the read permission are not used and will always be false.
+
+ </td>
+ </tr>
+
</table>
<h4>Example JSON</h4>
<code class="example"><span class="open-object">{
@@ -30788,6 +31363,8 @@
"tenantsPermissions": <span class="nested collapsed"><span class="nested-id hidden">PermissionsDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
"controllerPermissions": <span class="nested collapsed"><span class="nested-id hidden">PermissionsDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
"policiesPermissions": <span class="nested collapsed"><span class="nested-id hidden">PermissionsDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
+ "systemPermissions": <span class="nested collapsed"><span class="nested-id hidden">PermissionsDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
+ "restrictedComponentsPermissions": <span class="nested collapsed"><span class="nested-id hidden">PermissionsDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
}</span></code>
</div>
<div class="close">Close</div>
@@ -30872,7 +31449,7 @@
</td>
<td>optional</td>
- <td>The fulley qualified name of the type.
+ <td>The fully qualified name of the type.
</td>
</tr>
@@ -30894,6 +31471,22 @@
</tr>
<tr>
+ <td>usageRestriction</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>The description of why the usage of this component is restricted.
+
+ </td>
+ </tr>
+
+ <tr>
<td>tags</td>
<td>
@@ -30914,6 +31507,7 @@
<code class="example"><span class="open-object">{
"type": "value"<span class="comma">,</span>
"description": "value"<span class="comma">,</span>
+ "usageRestriction": "value"<span class="comma">,</span>
"tags": ["value"]<span class="comma">,</span>
}</span></code>
</div>
@@ -30971,7 +31565,7 @@
- string (date-time)
+ string
</td>
@@ -30987,7 +31581,7 @@
- string (date-time)
+ string
</td>
@@ -31446,7 +32040,7 @@
- string (date-time)
+ string
</td>
@@ -31926,7 +32520,7 @@
<td>
- array[<a class="type-link" href="javascript:void(0);">ProcessGroupDTO</a>]
+ <a class="type-link" href="javascript:void(0);">Set</a>
@@ -32068,7 +32662,7 @@
</table>
<h4>Example JSON</h4>
<code class="example"><span class="open-object">{
- "processGroups": [<span class="nested collapsed"><span class="nested-id hidden">ProcessGroupDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
+ "processGroups": <span class="nested collapsed"><span class="nested-id hidden">Set</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
"remoteProcessGroups": [<span class="nested collapsed"><span class="nested-id hidden">RemoteProcessGroupDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
"processors": [<span class="nested collapsed"><span class="nested-id hidden">ProcessorDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
"inputPorts": [<span class="nested collapsed"><span class="nested-id hidden">PortDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
@@ -32494,7 +33088,7 @@
- string (date-time)
+ string
</td>
@@ -33067,7 +33661,7 @@
- string (date-time)
+ string
</td>
@@ -33083,7 +33677,7 @@
- string (date-time)
+ string
</td>
@@ -33423,7 +34017,7 @@
- string (date-time)
+ string
</td>
@@ -33439,7 +34033,7 @@
- string (date-time)
+ string
</td>
@@ -33562,7 +34156,7 @@
</tr>
<tr>
- <td>destinationRunning</td>
+ <td>sourceRunning</td>
<td>
@@ -33572,13 +34166,13 @@
</td>
<td>optional</td>
- <td>Whether the destination of the connection is running
+ <td>Whether the source of the connection is running
</td>
</tr>
<tr>
- <td>sourceRunning</td>
+ <td>destinationRunning</td>
<td>
@@ -33588,7 +34182,7 @@
</td>
<td>optional</td>
- <td>Whether the source of the connection is running
+ <td>Whether the destination of the connection is running
</td>
</tr>
@@ -33607,8 +34201,8 @@
"state": "value"<span class="comma">,</span>
"queueSize": <span class="nested collapsed"><span class="nested-id hidden">QueueSizeDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
"flowFileSummaries": [<span class="nested collapsed"><span class="nested-id hidden">FlowFileSummaryDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
- "destinationRunning": true<span class="comma">,</span>
"sourceRunning": true<span class="comma">,</span>
+ "destinationRunning": true<span class="comma">,</span>
}</span></code>
</div>
<div class="close">Close</div>
@@ -33913,7 +34507,7 @@
- string (date-time)
+ string
</td>
@@ -33929,7 +34523,7 @@
- string (date-time)
+ string
</td>
@@ -34009,7 +34603,7 @@
- string (date-time)
+ string
</td>
@@ -34095,7 +34689,7 @@
- string (date-time)
+ string
</td>
@@ -35455,7 +36049,7 @@
- string (date-time)
+ string
</td>
@@ -35955,7 +36549,7 @@
- string (date-time)
+ string
</td>
@@ -36134,7 +36728,7 @@
</td>
<td>optional</td>
- <td>The number of running componetns in this process group.
+ <td>The number of running components in this process group.
</td>
</tr>
@@ -36251,6 +36845,22 @@
</td>
</tr>
+ <tr>
+ <td>contents</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">FlowSnippetDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>The contents of this process group.
+
+ </td>
+ </tr>
+
</table>
<h4>Example JSON</h4>
<code class="example"><span class="open-object">{
@@ -36267,6 +36877,7 @@
"inactiveRemotePortCount": 0<span class="comma">,</span>
"inputPortCount": 0<span class="comma">,</span>
"outputPortCount": 0<span class="comma">,</span>
+ "contents": <span class="nested collapsed"><span class="nested-id hidden">FlowSnippetDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
}</span></code>
</div>
<div class="close">Close</div>
@@ -36424,7 +37035,7 @@
</td>
<td>optional</td>
- <td>The number of running componetns in this process group.
+ <td>The number of running components in this process group.
</td>
</tr>
@@ -36664,7 +37275,7 @@
- string (date-time)
+ string
</td>
@@ -36794,7 +37405,7 @@
- string (date-time)
+ string
</td>
@@ -37328,7 +37939,7 @@
</td>
<td>optional</td>
- <td>The count/size transferred to/frome queues in the process group in the last 5 minutes.
+ <td>The count/size transferred to/from queues in the process group in the last 5 minutes.
</td>
</tr>
@@ -37619,6 +38230,22 @@
</tr>
<tr>
+ <td>executionNode</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Indicates the node where the process will execute.
+
+ </td>
+ </tr>
+
+ <tr>
<td>penaltyDuration</td>
<td>
@@ -37821,6 +38448,7 @@
}</span><span class="comma">,</span>
"schedulingPeriod": "value"<span class="comma">,</span>
"schedulingStrategy": "value"<span class="comma">,</span>
+ "executionNode": "value"<span class="comma">,</span>
"penaltyDuration": "value"<span class="comma">,</span>
"yieldDuration": "value"<span class="comma">,</span>
"bulletinLevel": "value"<span class="comma">,</span>
@@ -38064,6 +38692,22 @@
</tr>
<tr>
+ <td>restricted</td>
+ <td>
+
+
+
+ boolean
+
+
+ </td>
+ <td>optional</td>
+ <td>Whether the processor requires elevated privileges.
+
+ </td>
+ </tr>
+
+ <tr>
<td>inputRequirement</td>
<td>
@@ -38090,7 +38734,7 @@
</td>
<td>optional</td>
- <td>The configuration details for the processor. These details will be included in a resopnse if the verbose flag is included in a request.
+ <td>The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.
</td>
</tr>
@@ -38129,6 +38773,7 @@
"supportsEventDriven": true<span class="comma">,</span>
"supportsBatching": true<span class="comma">,</span>
"persistsState": true<span class="comma">,</span>
+ "restricted": true<span class="comma">,</span>
"inputRequirement": "value"<span class="comma">,</span>
"config": <span class="nested collapsed"><span class="nested-id hidden">ProcessorConfigDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
"validationErrors": ["value"]<span class="comma">,</span>
@@ -38410,7 +39055,7 @@
- string (date-time)
+ string
</td>
@@ -39088,7 +39733,7 @@
</td>
<td>optional</td>
- <td>The descriptoin for the property. Used to relay additional details to a user or provide a mechanism of documenting intent.
+ <td>The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent.
</td>
</tr>
@@ -39350,7 +39995,7 @@
- string (date-time)
+ string
</td>
@@ -39366,7 +40011,7 @@
- string (date-time)
+ string
</td>
@@ -39545,7 +40190,7 @@
- string (date-time)
+ string
</td>
@@ -40317,7 +40962,7 @@
- string (date-time)
+ string
</td>
@@ -40503,7 +41148,7 @@
- string (date-time)
+ string
</td>
@@ -40657,7 +41302,7 @@
- string (date-time)
+ string
</td>
@@ -40673,7 +41318,7 @@
- string (date-time)
+ string
</td>
@@ -40815,7 +41460,7 @@
- string (date-time)
+ string
</td>
@@ -40831,7 +41476,7 @@
- string (date-time)
+ string
</td>
@@ -41295,7 +41940,7 @@
</td>
<td>optional</td>
- <td>The time period used for the timeout when commicating with the target.
+ <td>The time period used for the timeout when communicating with the target.
</td>
</tr>
@@ -41503,7 +42148,7 @@
</td>
<td>optional</td>
- <td>The number of acitve remote output ports.
+ <td>The number of active remote output ports.
</td>
</tr>
@@ -41530,7 +42175,7 @@
- string (date-time)
+ string
</td>
@@ -42209,7 +42854,7 @@
- string (date-time)
+ string
</td>
@@ -42516,7 +43161,7 @@
</td>
<td>optional</td>
- <td>The id of the remote processo group.
+ <td>The id of the remote process group.
</td>
</tr>
@@ -42744,6 +43389,22 @@
</tr>
<tr>
+ <td>restricted</td>
+ <td>
+
+
+
+ boolean
+
+
+ </td>
+ <td>optional</td>
+ <td>Whether the reporting task requires elevated privileges.
+
+ </td>
+ </tr>
+
+ <tr>
<td>schedulingPeriod</td>
<td>
@@ -42850,7 +43511,7 @@
</td>
<td>optional</td>
- <td>The anntation data for the repoting task. This is how the custom UI relays configuration to the reporting task.
+ <td>The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task.
</td>
</tr>
@@ -42898,6 +43559,7 @@
"state": "value"<span class="comma">,</span>
"comments": "value"<span class="comma">,</span>
"persistsState": true<span class="comma">,</span>
+ "restricted": true<span class="comma">,</span>
"schedulingPeriod": "value"<span class="comma">,</span>
"schedulingStrategy": "value"<span class="comma">,</span>
"defaultSchedulingPeriod": <span class="open-object">{
@@ -44120,7 +44782,7 @@
- string (date-time)
+ string
</td>
@@ -45066,7 +45728,7 @@
- string (date-time)
+ string
</td>
@@ -45076,6 +45738,22 @@
</td>
</tr>
+ <tr>
+ <td>versionInfo</td>
+ <td>
+
+
+ <a class="type-link" href="javascript:void(0);">VersionInfoDTO</a>
+
+
+
+ </td>
+ <td>optional</td>
+ <td>The nifi, os, java, and build version information
+
+ </td>
+ </tr>
+
</table>
<h4>Example JSON</h4>
<code class="example"><span class="open-object">{
@@ -45105,6 +45783,7 @@
"contentRepositoryStorageUsage": [<span class="nested collapsed"><span class="nested-id hidden">StorageUsageDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
"garbageCollection": [<span class="nested collapsed"><span class="nested-id hidden">GarbageCollectionDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
"statsLastRefreshed": "value"<span class="comma">,</span>
+ "versionInfo": <span class="nested collapsed"><span class="nested-id hidden">VersionInfoDTO</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span>
}</span></code>
</div>
<div class="close">Close</div>
@@ -45209,7 +45888,7 @@
- string (date-time)
+ string
</td>
@@ -45442,12 +46121,12 @@
- string (date-time)
+ string
</td>
<td>optional</td>
- <td>
+ <td>When this content was generated.
</td>
</tr>
@@ -45693,6 +46372,61 @@
</div>
+<div id="TenantsEntity" class="type hidden">
+ <h3>TenantsEntity</h3>
+ <div class="type-container">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>users</td>
+ <td>
+
+
+ array[<a class="type-link" href="javascript:void(0);">TenantEntity</a>]
+
+
+
+ </td>
+ <td>optional</td>
+ <td>
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>userGroups</td>
+ <td>
+
+
+ array[<a class="type-link" href="javascript:void(0);">TenantEntity</a>]
+
+
+
+ </td>
+ <td>optional</td>
+ <td>
+
+ </td>
+ </tr>
+
+ </table>
+ <h4>Example JSON</h4>
+ <code class="example"><span class="open-object">{
+ "users": [<span class="nested collapsed"><span class="nested-id hidden">TenantEntity</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
+ "userGroups": [<span class="nested collapsed"><span class="nested-id hidden">TenantEntity</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
+}</span></code>
+ </div>
+ <div class="close">Close</div>
+ <div class="clear"></div>
+</div>
+
+
<div id="TransactionResultEntity" class="type hidden">
<h3>TransactionResultEntity</h3>
<div class="type-container">
@@ -46204,7 +46938,7 @@
</td>
<td>optional</td>
- <td>The access policies this user group belongs to.
+ <td>The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.
This property is read only.</td>
</tr>
@@ -46420,12 +47154,12 @@
- string (date-time)
+ string
</td>
<td>optional</td>
- <td>
+ <td>When this content was generated.
</td>
</tr>
@@ -46454,6 +47188,197 @@
}</span></code>
</div>
<div class="close">Close</div>
+ <div class="clear"></div>
+</div>
+
+
+<div id="VersionInfoDTO" class="type hidden">
+ <h3>VersionInfoDTO</h3>
+ <div class="type-container">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>javaVendor</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Java JVM vendor
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>javaVersion</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Java version
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>osName</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Host operating system name
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>osVersion</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Host operating system version
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>osArchitecture</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Host operating system architecture
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>buildTag</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Build tag
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>buildRevision</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Build revision or commit hash
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>buildBranch</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>Build branch
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>buildTimestamp</td>
+ <td>
+
+
+
+ string (date-time)
+
+
+ </td>
+ <td>optional</td>
+ <td>Build timestamp
+
+ </td>
+ </tr>
+
+ <tr>
+ <td>niFiVersion</td>
+ <td>
+
+
+
+ string
+
+
+ </td>
+ <td>optional</td>
+ <td>The version of this NiFi.
+
+ </td>
+ </tr>
+
+ </table>
+ <h4>Example JSON</h4>
+ <code class="example"><span class="open-object">{
+ "javaVendor": "value"<span class="comma">,</span>
+ "javaVersion": "value"<span class="comma">,</span>
+ "osName": "value"<span class="comma">,</span>
+ "osVersion": "value"<span class="comma">,</span>
+ "osArchitecture": "value"<span class="comma">,</span>
+ "buildTag": "value"<span class="comma">,</span>
+ "buildRevision": "value"<span class="comma">,</span>
+ "buildBranch": "value"<span class="comma">,</span>
+ "buildTimestamp": "value"<span class="comma">,</span>
+ "niFiVersion": "value"<span class="comma">,</span>
+}</span></code>
+ </div>
+ <div class="close">Close</div>
<div class="clear"></div>
</div>