Modified: nifi/site/trunk/docs/nifi-docs/rest-api/images/bgNifiLogo.png URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/rest-api/images/bgNifiLogo.png?rev=1873052&r1=1873051&r2=1873052&view=diff ============================================================================== Binary files - no diff available.
Modified: nifi/site/trunk/docs/nifi-docs/rest-api/images/nifi16.ico URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/rest-api/images/nifi16.ico?rev=1873052&r1=1873051&r2=1873052&view=diff ============================================================================== Binary files - no diff available. 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=1873052&r1=1873051&r2=1873052&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/rest-api/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/rest-api/index.html Thu Jan 23 03:48:17 2020 @@ -15,7 +15,7 @@ --> <html> <head> - <title>NiFi Rest Api-1.10.0</title> + <title>NiFi Rest Api-1.11.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/assets/jquery/dist/jquery.min.js"></script> @@ -471,7 +471,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.10.0</div> + <div class="sub-title">NiFi Rest Api 1.11.0</div> <div class="clear"></div> </div> <div class="clear"></div> @@ -20261,6 +20261,150 @@ <div class="endpoints"> + <span class="path hidden">/process-groups/{id}/download</span> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary">Gets a process group for download</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>id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The process group id.</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</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> + <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>404</td> + <td> + + string + + </td> + <td>The specified resource could not be found.</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>Read - /process-groups/{uuid}</div> + + + </div> +</div> + </div> + + + +</div> + + +<div class="endpoints"> <span class="path hidden">/process-groups/{id}/funnels</span> <div class="endpoint post"> @@ -33220,6 +33364,150 @@ <div class="endpoints"> + <span class="path hidden">/versions/process-groups/{id}/download</span> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary">Gets the latest version of a Process Group for download</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>id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The process group id.</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</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> + <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>404</td> + <td> + + string + + </td> + <td>The specified resource could not be found.</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>Read - /process-groups/{uuid}</div> + + + </div> +</div> + </div> + + + +</div> + + +<div class="endpoints"> <span class="path hidden">/versions/revert-requests/process-groups/{id}</span> <div class="endpoint post"> @@ -37553,7 +37841,7 @@ </tr> <tr> - <td>clustered</td> + <td>connectedToCluster</td> <td> @@ -37563,13 +37851,13 @@ </td> <td>optional</td> - <td>Whether this NiFi instance is clustered. + <td>Whether this NiFi instance is connected to a cluster. </td> </tr> <tr> - <td>connectedToCluster</td> + <td>clustered</td> <td> @@ -37579,7 +37867,7 @@ </td> <td>optional</td> - <td>Whether this NiFi instance is connected to a cluster. + <td>Whether this NiFi instance is clustered. </td> </tr> @@ -37590,8 +37878,8 @@ "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> + "clustered": true<span class="comma">,</span> }</span></code> </div> <div class="close">Close</div> @@ -52219,7 +52507,7 @@ </tr> <tr> - <td>inputPortCount</td> + <td>outputPortCount</td> <td> @@ -52229,13 +52517,13 @@ </td> <td>optional</td> - <td>The number of input ports in the process group. + <td>The number of output ports in the process group. This property is read only.</td> </tr> <tr> - <td>outputPortCount</td> + <td>inputPortCount</td> <td> @@ -52245,7 +52533,7 @@ </td> <td>optional</td> - <td>The number of output ports in the process group. + <td>The number of input ports in the process group. This property is read only.</td> </tr> @@ -52280,8 +52568,8 @@ "publicInputPortCount": 0<span class="comma">,</span> "publicOutputPortCount": 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> - "inputPortCount": 0<span class="comma">,</span> "outputPortCount": 0<span class="comma">,</span> + "inputPortCount": 0<span class="comma">,</span> }</span></code> </div> <div class="close">Close</div> @@ -52733,7 +53021,7 @@ </tr> <tr> - <td>inputPortCount</td> + <td>outputPortCount</td> <td> @@ -52743,13 +53031,13 @@ </td> <td>optional</td> - <td>The number of input ports in the process group. + <td>The number of output ports in the process group. This property is read only.</td> </tr> <tr> - <td>outputPortCount</td> + <td>inputPortCount</td> <td> @@ -52759,7 +53047,7 @@ </td> <td>optional</td> - <td>The number of output ports in the process group. + <td>The number of input ports in the process group. This property is read only.</td> </tr> @@ -52794,8 +53082,8 @@ "publicInputPortCount": 0<span class="comma">,</span> "publicOutputPortCount": 0<span class="comma">,</span> "parameterContext": <span class="nested collapsed"><span class="nested-id hidden">ParameterContextReferenceEntity</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span> - "inputPortCount": 0<span class="comma">,</span> "outputPortCount": 0<span class="comma">,</span> + "inputPortCount": 0<span class="comma">,</span> }</span></code> </div> <div class="close">Close</div>
