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=1730776&r1=1730775&r2=1730776&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/rest-api/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/rest-api/index.html Wed Feb 17 02:18:24 2016 @@ -15,7 +15,7 @@ --> <html> <head> - <title>NiFi Rest Api-0.4.0</title> + <title>NiFi Rest Api-0.5.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.4.0</div> + <div class="sub-title">NiFi Rest Api 0.5.0</div> <div class="clear"></div> </div> <div class="clear"></div> @@ -6893,6 +6893,359 @@ <div class="endpoints"> + <span class="path hidden">/controller/controller-services/{availability}/{id}/state</span> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary">Gets the state for a controller service</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>availability</td> + <td>path</td> + + + + <td>string </td> + + + + <td>Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE.</td> + </tr> + + <tr> + <td>id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The controller service 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, 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);">ComponentStateDTO</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>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>Data Flow Manager</div> + + + </div> +</div> + </div> + + + +</div> + + +<div class="endpoints"> + <span class="path hidden">/controller/controller-services/{availability}/{id}/state/clear-requests</span> + + <div class="endpoint post"> + <div class="operation-handle"> + <div class="method">POST</div> + <div class="path mono"></div> + <div class="summary">Clears the state for a controller service</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">application/x-www-form-urlencoded</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>formData</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>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>availability</td> + <td>path</td> + + + + <td>string </td> + + + + <td>Whether the controller service is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE.</td> + </tr> + + <tr> + <td>id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The controller service 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, 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);">ComponentStateDTO</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>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>Data Flow Manager</div> + + + </div> +</div> + </div> + + + + +</div> + + +<div class="endpoints"> <span class="path hidden">/controller/counters</span> @@ -8688,15 +9041,1057 @@ <tr> - <td></td> - <td>body</td> + <td></td> + <td>body</td> + + <td> + + <a class="type-link" href="javascript:void(0);">ProcessGroupEntity</a> + </td> + + <td>The process group to update. The only action that is supported at this endpoint is to set the running flag in order to start or stop all descendent schedulable components. This defines the schema of the expected input.</td> + </tr> + + <tr> + <td>process-group-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as 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, 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);">ProcessGroupEntity</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>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 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</span> + + <div class="endpoint post"> + <div class="operation-handle"> + <div class="method">POST</div> + <div class="path mono"></div> + <div class="summary">Creates a connection</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">application/json, application/xml</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></td> + <td>body</td> + + <td> + + <a class="type-link" href="javascript:void(0);">ConnectionEntity</a> + </td> + + <td>The connection configuration details.</td> + </tr> + + <tr> + <td>process-group-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as 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, 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);">ConnectionEntity</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>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>Data Flow Manager</div> + + + </div> +</div> + </div> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary">Gets all connections</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>process-group-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as 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, 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);">ConnectionsEntity</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>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 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}/contents</span> + + + + + <div class="endpoint delete"> + <div class="operation-handle"> + <div class="method">DELETE</div> + <div class="path mono"></div> + <div class="summary">Drops the contents of the queue in this connection.</div> + <div class="clear"></div> + </div> + +<div class="operation hidden"> + + <div class="description"> + This endpoint is DEPRECATED. Please use POST /nifi-api/controller/process-groups/{process-group-id}/connections/{connection-id}/drop-requests instead. + </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> + + <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>connection-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The connection id.</td> + </tr> + + <tr> + <td>process-group-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as 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, 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);">DropRequestEntity</a> + + </td> + <td>successful operation</td> + </tr> + + <tr> + <td>202</td> + <td> + + string + + </td> + <td>The request has been accepted. A HTTP response header will contain the URI where the response can be polled.</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>Data Flow Manager</div> + + + </div> +</div> + </div> + +</div> + + +<div class="endpoints"> + <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{connection-id}/drop-requests</span> + + <div class="endpoint post"> + <div class="operation-handle"> + <div class="method">POST</div> + <div class="path mono"></div> + <div class="summary">Creates a request to drop the contents of the queue in this connection.</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">application/x-www-form-urlencoded</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>formData</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> + + + + <td>string </td> + + + + <td>The connection id.</td> + </tr> + + <tr> + <td>process-group-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as 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, 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);">DropRequestEntity</a> + + </td> + <td>successful operation</td> + </tr> + + <tr> + <td>202</td> + <td> + + string + + </td> + <td>The request has been accepted. A HTTP response header will contain the URI where the response can be polled.</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>Data Flow Manager</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 get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary">Gets the current status of a drop request for the specified connection.</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>connection-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The connection id.</td> + </tr> + + <tr> + <td>drop-request-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The drop request id.</td> + </tr> + + <tr> + <td>process-group-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as 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, 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);">DropRequestEntity</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>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>Data Flow Manager</div> + + + </div> +</div> + </div> + + + + <div class="endpoint delete"> + <div class="operation-handle"> + <div class="method">DELETE</div> + <div class="path mono"></div> + <div class="summary">Cancels and/or removes a request to drop the contents of this connection.</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>connection-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The connection id.</td> + </tr> + + <tr> + <td>drop-request-id</td> + <td>path</td> - <td> - <a class="type-link" href="javascript:void(0);">ProcessGroupEntity</a> - </td> + + <td>string </td> + + - <td>The process group to update. The only action that is supported at this endpoint is to set the running flag in order to start or stop all descendent schedulable components. This defines the schema of the expected input.</td> + <td>The drop request id.</td> </tr> <tr> @@ -8736,7 +10131,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ProcessGroupEntity</a> + <a class="type-link" href="javascript:void(0);">DropRequestEntity</a> </td> <td>successful operation</td> @@ -8798,33 +10193,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</span> + <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{connection-id}/flowfiles/{flowfile-uuid}</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 connection</div> + <div class="summary">Gets a FlowFile from a Connection.</div> <div class="clear"></div> </div> @@ -8833,7 +10220,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> @@ -8850,15 +10237,55 @@ <tr> - <td></td> - <td>body</td> + <td>clientId</td> + <td>query</td> - <td> - <a class="type-link" href="javascript:void(0);">ConnectionEntity</a> - </td> + + <td>string</td> + + - <td>The connection configuration details.</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> + + + + <td>string </td> + + + + <td>The connection id.</td> + </tr> + + <tr> + <td>flowfile-uuid</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The flowfile uuid.</td> + </tr> + + <tr> + <td>clusterNodeId</td> + <td>query</td> + + + + <td>string </td> + + + + <td>The id of the node where the content exists if clustered.</td> </tr> <tr> @@ -8895,16 +10322,6 @@ <tbody> <tr> - <td>200</td> - <td> - - <a class="type-link" href="javascript:void(0);">ConnectionEntity</a> - - </td> - <td>successful operation</td> - </tr> - - <tr> <td>400</td> <td> @@ -8968,11 +10385,19 @@ </div> + +</div> + + +<div class="endpoints"> + <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{connection-id}/flowfiles/{flowfile-uuid}/content</span> + + <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Gets all connections</div> + <div class="summary">Gets the content for a FlowFile in a Connection.</div> <div class="clear"></div> </div> @@ -9011,6 +10436,45 @@ </tr> <tr> + <td>connection-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The connection id.</td> + </tr> + + <tr> + <td>flowfile-uuid</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The flowfile uuid.</td> + </tr> + + <tr> + <td>clusterNodeId</td> + <td>query</td> + + + + <td>string </td> + + + + <td>The id of the node where the content exists if clustered.</td> + </tr> + + <tr> <td>process-group-id</td> <td>path</td> @@ -9030,7 +10494,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">*/*</div><div class="clear"></div></div> </div> <table> @@ -9044,16 +10508,6 @@ <tbody> <tr> - <td>200</td> - <td> - - <a class="type-link" href="javascript:void(0);">ConnectionsEntity</a> - - </td> - <td>successful operation</td> - </tr> - - <tr> <td>400</td> <td> @@ -9109,17 +10563,9 @@ <div class="authorization details"> - <div>Read Only</div> - - - <div>Data Flow Manager</div> - - <div>Administrator</div> - - </div> </div> </div> @@ -9130,16 +10576,13 @@ <div class="endpoints"> - <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{connection-id}/contents</span> - + <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{connection-id}/listing-requests</span> - - - <div class="endpoint delete"> + <div class="endpoint post"> <div class="operation-handle"> - <div class="method">DELETE</div> + <div class="method">POST</div> <div class="path mono"></div> - <div class="summary">Drops the contents of the queue in this connection.</div> + <div class="summary">Lists the contents of the queue in this connection.</div> <div class="clear"></div> </div> @@ -9148,7 +10591,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> @@ -9166,7 +10609,7 @@ <tr> <td>clientId</td> - <td>query</td> + <td>formData</td> @@ -9227,13 +10670,23 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">DropRequestEntity</a> + <a class="type-link" href="javascript:void(0);">ListingRequestEntity</a> </td> <td>successful operation</td> </tr> <tr> + <td>202</td> + <td> + + string + + </td> + <td>The request has been accepted. A HTTP response header will contain the URI where the response can be polled.</td> + </tr> + + <tr> <td>400</td> <td> @@ -9296,18 +10749,21 @@ </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> + <span class="path hidden">/controller/process-groups/{process-group-id}/connections/{connection-id}/listing-requests/{listing-request-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 current status of a drop request for the specified connection.</div> + <div class="summary">Gets the current status of a listing request for the specified connection.</div> <div class="clear"></div> </div> @@ -9359,7 +10815,7 @@ </tr> <tr> - <td>drop-request-id</td> + <td>listing-request-id</td> <td>path</td> @@ -9368,7 +10824,7 @@ - <td>The drop request id.</td> + <td>The listing request id.</td> </tr> <tr> @@ -9408,7 +10864,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">DropRequestEntity</a> + <a class="type-link" href="javascript:void(0);">ListingRequestEntity</a> </td> <td>successful operation</td> @@ -9483,7 +10939,7 @@ <div class="operation-handle"> <div class="method">DELETE</div> <div class="path mono"></div> - <div class="summary">Cancels and/or removes a request drop of the contents in this connection.</div> + <div class="summary">Cancels and/or removes a request to list the contents of this connection.</div> <div class="clear"></div> </div> @@ -9535,7 +10991,7 @@ </tr> <tr> - <td>drop-request-id</td> + <td>listing-request-id</td> <td>path</td> @@ -9544,7 +11000,7 @@ - <td>The drop request id.</td> + <td>The listing request id.</td> </tr> <tr> @@ -14495,24 +15951,337 @@ <div class="authorization details"> - <div>Data Flow Manager</div> + <div>Data Flow Manager</div> + + + </div> +</div> + </div> + +</div> + + +<div class="endpoints"> + <span class="path hidden">/controller/process-groups/{process-group-id}/processors</span> + + <div class="endpoint post"> + <div class="operation-handle"> + <div class="method">POST</div> + <div class="path mono"></div> + <div class="summary">Creates a new processor</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">application/json, application/xml</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></td> + <td>body</td> + + <td> + + <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> + </td> + + <td>The processor configuration details.</td> + </tr> + + <tr> + <td>process-group-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as 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, 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);">ProcessorEntity</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>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>ROLE_DFM</div> + + + </div> +</div> + </div> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary">Gets all processors</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></td> + </tr> + + <tr> + <td>process-group-id</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The id of the process group that is the parent of the requested resource(s). If the desired process group is the root group an alias 'root' may be used as 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, 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);">ProcessorsEntity</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>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 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}/processors</span> + <span class="path hidden">/controller/process-groups/{process-group-id}/processors/{id}</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 processor</div> + <div class="summary">Gets a processor</div> <div class="clear"></div> </div> @@ -14521,7 +16290,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> @@ -14538,15 +16307,29 @@ <tr> - <td></td> - <td>body</td> + <td>clientId</td> + <td>query</td> - <td> - <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> - </td> + + <td>string</td> + + - <td>The processor configuration details.</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>The processor id.</td> </tr> <tr> @@ -14648,7 +16431,15 @@ <div class="authorization details"> - <div>ROLE_DFM</div> + <div>Read Only</div> + + + + <div>Data Flow Manager</div> + + + + <div>Administrator</div> </div> @@ -14656,11 +16447,11 @@ </div> - <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 all processors</div> + <div class="summary">Updates a processor</div> <div class="clear"></div> </div> @@ -14669,7 +16460,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> @@ -14686,16 +16477,28 @@ <tr> - <td>clientId</td> - <td>query</td> + <td>id</td> + <td>path</td> - <td>string</td> + <td>string </td> + <td>The processor id.</td> + </tr> + + <tr> <td></td> + <td>body</td> + + <td> + + <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> + </td> + + <td>The processor configuration details.</td> </tr> <tr> @@ -14735,7 +16538,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ProcessorsEntity</a> + <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> </td> <td>successful operation</td> @@ -14797,35 +16600,19 @@ <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}/processors/{id}</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 processor</div> + <div class="summary">Deletes a processor</div> <div class="clear"></div> </div> @@ -14851,6 +16638,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> @@ -14975,27 +16775,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}/processors/{id}/descriptors</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 processor</div> + <div class="summary">Gets the descriptor for a processor property</div> <div class="clear"></div> </div> @@ -15004,7 +16802,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> @@ -15021,6 +16819,19 @@ <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>id</td> <td>path</td> @@ -15034,15 +16845,16 @@ </tr> <tr> - <td></td> - <td>body</td> + <td>propertyName</td> + <td>query</td> - <td> - <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> - </td> + + <td>string </td> + + - <td>The processor configuration details.</td> + <td>The property name.</td> </tr> <tr> @@ -15082,7 +16894,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> + <a class="type-link" href="javascript:void(0);">PropertyDescriptorEntity</a> </td> <td>successful operation</td> @@ -15144,19 +16956,35 @@ <div class="authorization details"> + <div>Read Only</div> + + + <div>Data Flow Manager</div> + + <div>Administrator</div> + + </div> </div> </div> - <div class="endpoint delete"> + +</div> + + +<div class="endpoints"> + <span class="path hidden">/controller/process-groups/{process-group-id}/processors/{id}/state</span> + + + <div class="endpoint get"> <div class="operation-handle"> - <div class="method">DELETE</div> + <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Deletes a processor</div> + <div class="summary">Gets the state for a processor</div> <div class="clear"></div> </div> @@ -15182,19 +17010,6 @@ <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> @@ -15257,7 +17072,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ProcessorEntity</a> + <a class="type-link" href="javascript:void(0);">ComponentStateDTO</a> </td> <td>successful operation</td> @@ -15326,18 +17141,19 @@ </div> </div> + + </div> <div class="endpoints"> - <span class="path hidden">/controller/process-groups/{process-group-id}/processors/{id}/descriptors</span> - + <span class="path hidden">/controller/process-groups/{process-group-id}/processors/{id}/state/clear-requests</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 the descriptor for a processor property</div> + <div class="summary">Clears the state for a processor</div> <div class="clear"></div> </div> @@ -15346,7 +17162,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> @@ -15364,7 +17180,7 @@ <tr> <td>clientId</td> - <td>query</td> + <td>formData</td> @@ -15376,21 +17192,21 @@ </tr> <tr> - <td>id</td> - <td>path</td> + <td>version</td> + <td>formData</td> - <td>string </td> + <td>string</td> - <td>The processor id.</td> + <td>The revision is used to verify the client is working with the latest version of the flow.</td> </tr> <tr> - <td>propertyName</td> - <td>query</td> + <td>id</td> + <td>path</td> @@ -15398,7 +17214,7 @@ - <td>The property name.</td> + <td>The processor id.</td> </tr> <tr> @@ -15438,7 +17254,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">PropertyDescriptorEntity</a> + <a class="type-link" href="javascript:void(0);">ComponentStateDTO</a> </td> <td>successful operation</td> @@ -15500,23 +17316,16 @@ <div class="authorization details"> - <div>Read Only</div> - - - <div>Data Flow Manager</div> - - <div>Administrator</div> - - </div> </div> </div> + </div> @@ -19721,7 +21530,286 @@ <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary">Retrieves the types of reporting tasks that this NiFi supports</div> + <div class="summary">Retrieves the types of reporting tasks 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> + + + </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);">ReportingTaskTypesEntity</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>Read Only</div> + + + + <div>Data Flow Manager</div> + + + + <div>Administrator</div> + + + </div> +</div> + </div> + + + +</div> + + +<div class="endpoints"> + <span class="path hidden">/controller/reporting-tasks/{availability}</span> + + <div class="endpoint post"> + <div class="operation-handle"> + <div class="method">POST</div> + <div class="path mono"></div> + <div class="summary">Creates a new reporting task</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">application/json, application/xml</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>availability</td> + <td>path</td> + + + + <td>string </td> + + + + <td>Whether the reporting task is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE.</td> + </tr> + + <tr> + <td></td> + <td>body</td> + + <td> + + <a class="type-link" href="javascript:void(0);">ReportingTaskEntity</a> + </td> + + <td>The reporting task configuration details.</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);">ReportingTaskEntity</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 class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary">Gets all reporting tasks</div> <div class="clear"></div> </div> @@ -19759,6 +21847,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>availability</td> + <td>path</td> + + + + <td>string </td> + + + + <td>Whether the reporting task is available on the NCM or nodes. If the NiFi is standalone the availability should be NODE.</td> + </tr> + </tbody> </table> @@ -19783,7 +21884,7 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">ReportingTaskTypesEntity</a> + <a class="type-link" href="javascript:void(0);">ReportingTasksEntity</a> </td> <td>successful operation</td> @@ -19856,13 +21957,14 @@ <div class="endpoints"> - <span class="path hidden">/controller/reporting-tasks/{availability}</span> + <span class="path hidden">/controller/reporting-tasks/{availability}/{id}</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 reporting task</div> + <div class="summary">Gets a reporting task</div> <div class="clear"></div> </div> @@ -19871,7 +21973,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> @@ -19888,6 +21990,19 @@ <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>availability</td> <td>path</td> @@ -19901,15 +22016,16 @@ </tr> <tr> - <td></td> - <td>body</td> + <td>id</td> + <td>path</td> - <td> - <a class="type-link" href="javascript:void(0);">ReportingTaskEntity</a> - </td> + + <td>string </td> + + - <td>The reporting task configuration details.</td> + <td>The reporting task id.</td> </tr> @@ -19973,6 +22089,16 @@ </tr> <tr> + <td>404</td> + <td> + + string + + </td> + <td>The specified resource could not be found.</td> + </tr> + + <tr> <td>409</td> <td> @@ -19988,19 +22114,27 @@ <div class="authorization details"> + <div>Read Only</div> + + + <div>Data Flow Manager</div> + + <div>Administrator</div> + + </div> </div> </div> - <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 all reporting tasks</div> + <div class="summary">Updates a reporting task</div> <div class="clear"></div> </div> @@ -20009,7 +22143,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>
[... 1438 lines stripped ...]
