Modified: nifi/site/trunk/docs/nifi-registry-docs/rest-api/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-registry-docs/rest-api/index.html?rev=1834040&r1=1834039&r2=1834040&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-registry-docs/rest-api/index.html (original) +++ nifi/site/trunk/docs/nifi-registry-docs/rest-api/index.html Thu Jun 21 18:18:06 2018 @@ -15,10 +15,10 @@ --> <html> <head> - <title>NiFi Registry REST API-0.1.0</title> + <title>NiFi Registry REST API-0.2.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="http://localhost:18080/nifi/assets/jquery/dist/jquery.min.js";></script> + <script type="text/javascript" src="http://localhost:8080/nifi/assets/jquery/dist/jquery.min.js";></script> <script type="text/javascript"> if (typeof window.jQuery === 'undefined') { document.write(unescape('%3Cscript src="https://code.jquery.com/jquery-3.1.1.min.js"; type="text/javascript" %3E%3C/script%3E')); @@ -456,13 +456,11 @@ <div class="header"> <img class="logo" src="images/bgNifiLogo.png" alt="NiFi Logo"/> <div class="title">/nifi-registry-api</div> - <div class="sub-title">NiFi Registry REST API 0.1.0</div> + <div class="sub-title">NiFi Registry REST API 0.2.0</div> <div class="clear"></div> </div> <div class="clear"></div> - <div class="overview">The Rest Api provides an interface to a registry with operations for saving, - versioning, reading NiFi flows - and components.</div> + <div class="overview">The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.</div> <div class="section"> <div class="section-header"> <div class="title link">Buckets</div> @@ -550,7 +548,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">currentUser</a> + + <a class="type-link" href="javascript:void(0);">currentUser</a> + </td> <td>successful operation</td> @@ -568,10 +568,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -627,6 +624,8 @@ <td> + + </td> <td>successful operation</td> @@ -674,10 +673,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -734,6 +730,8 @@ <td> + + </td> <td>successful operation</td> @@ -781,10 +779,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -841,6 +836,8 @@ <td> + + </td> <td>successful operation</td> @@ -888,10 +885,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -945,6 +939,8 @@ <td> + + </td> <td>successful operation</td> @@ -982,10 +978,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -1041,6 +1034,8 @@ <td> + + </td> <td>successful operation</td> @@ -1088,10 +1083,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -1148,6 +1140,8 @@ <td> + + </td> <td>successful operation</td> @@ -1195,10 +1189,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -1228,7 +1219,33 @@ </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);">bucket</a> + </td> + + <td>The bucket to create</td> + </tr> + + </tbody> + </table> <div class="title">Response</div> <div class="mediatypes details"> @@ -1250,7 +1267,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">bucket</a> + + <a class="type-link" href="javascript:void(0);">bucket</a> + </td> <td>successful operation</td> @@ -1288,10 +1307,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/buckets + </div> + </div> </div> @@ -1340,6 +1361,10 @@ <td> + + array[<a class="type-link" href="javascript:void(0);">bucket</a>] + + </td> <td>successful operation</td> @@ -1357,10 +1382,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -1412,7 +1434,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">Fields</a> + + <a class="type-link" href="javascript:void(0);">Fields</a> + </td> <td>successful operation</td> @@ -1420,10 +1444,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -1502,7 +1523,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">bucket</a> + + <a class="type-link" href="javascript:void(0);">bucket</a> + </td> <td>successful operation</td> @@ -1540,10 +1563,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + </div> </div> @@ -1590,6 +1615,18 @@ <td>The bucket identifier</td> </tr> + <tr> + <td></td> + <td>body</td> + + <td> + + <a class="type-link" href="javascript:void(0);">bucket</a> + </td> + + <td>The updated bucket</td> + </tr> + </tbody> </table> @@ -1614,7 +1651,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">bucket</a> + + <a class="type-link" href="javascript:void(0);">bucket</a> + </td> <td>successful operation</td> @@ -1672,10 +1711,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/buckets/{bucketId} + </div> + </div> </div> @@ -1746,7 +1787,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">bucket</a> + + <a class="type-link" href="javascript:void(0);">bucket</a> + </td> <td>successful operation</td> @@ -1794,10 +1837,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: delete:/buckets/{bucketId} + </div> + </div> </div> @@ -1853,6 +1898,18 @@ <td>The bucket identifier</td> </tr> + <tr> + <td></td> + <td>body</td> + + <td> + + <a class="type-link" href="javascript:void(0);">versionedFlow</a> + </td> + + <td>The details of the flow to create.</td> + </tr> + </tbody> </table> @@ -1877,7 +1934,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">versionedFlow</a> + + <a class="type-link" href="javascript:void(0);">versionedFlow</a> + </td> <td>successful operation</td> @@ -1935,10 +1994,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/buckets/{bucketId} + </div> + </div> </div> @@ -2010,6 +2071,10 @@ <td> + + array[<a class="type-link" href="javascript:void(0);">versionedFlow</a>] + + </td> <td>successful operation</td> @@ -2067,10 +2132,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + </div> </div> @@ -2162,7 +2229,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">versionedFlow</a> + + <a class="type-link" href="javascript:void(0);">versionedFlow</a> + </td> <td>successful operation</td> @@ -2220,10 +2289,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + </div> </div> @@ -2283,6 +2354,18 @@ <td>The flow identifier</td> </tr> + <tr> + <td></td> + <td>body</td> + + <td> + + <a class="type-link" href="javascript:void(0);">versionedFlow</a> + </td> + + <td>The updated flow</td> + </tr> + </tbody> </table> @@ -2307,7 +2390,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">versionedFlow</a> + + <a class="type-link" href="javascript:void(0);">versionedFlow</a> + </td> <td>successful operation</td> @@ -2365,10 +2450,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/buckets/{bucketId} + </div> + </div> </div> @@ -2377,7 +2464,7 @@ <div class="operation-handle"> <div class="method">DELETE</div> <div class="path mono"></div> - <div class="summary" title="Deletes a flow.">Deletes a flow.</div> + <div class="summary" title="Deletes a flow, including all saved versions of that flow.">Deletes a flow, including all saved versions of that flow.</div> <div class="clear"></div> </div> @@ -2452,7 +2539,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">versionedFlow</a> + + <a class="type-link" href="javascript:void(0);">versionedFlow</a> + </td> <td>successful operation</td> @@ -2500,10 +2589,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: delete:/buckets/{bucketId} + </div> + </div> </div> @@ -2511,22 +2602,19 @@ <div class="endpoints"> - <span class="path hidden">/buckets/{bucketId}/flows/{flowId}/versions</span> + <span class="path hidden">/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}</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" title="Creates the next version of a flow">Creates the next version of a flow</div> + <div class="summary" title="Returns a list of differences between 2 versions of a flow">Returns a list of differences between 2 versions of a flow</div> <div class="clear"></div> </div> <div class="operation hidden"> - <div class="description"> - The version number is created by the server and populated in the returned entity. - </div> - <div class="title">Request</div> <div class="mediatypes details"> @@ -2572,6 +2660,32 @@ <td>The flow identifier</td> </tr> + <tr> + <td>versionA</td> + <td>path</td> + + + + <td>integer (int32)</td> + + + + <td>The first version number</td> + </tr> + + <tr> + <td>versionB</td> + <td>path</td> + + + + <td>integer (int32)</td> + + + + <td>The second version number</td> + </tr> + </tbody> </table> @@ -2596,7 +2710,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> + + <a class="type-link" href="javascript:void(0);">VersionedFlowDifference</a> + </td> <td>successful operation</td> @@ -2654,24 +2770,37 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + </div> </div> - <div class="endpoint get"> + +</div> + + +<div class="endpoints"> + <span class="path hidden">/buckets/{bucketId}/flows/{flowId}/versions</span> + + <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" title="Gets summary information for all versions of a flow. Versions are ordered newest->oldest.">Gets summary information for all versions of a flow. Versions are ordered newest->oldest.</div> + <div class="summary" title="Creates the next version of a flow">Creates the next version of a flow</div> <div class="clear"></div> </div> <div class="operation hidden"> + <div class="description"> + The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created. + </div> + <div class="title">Request</div> <div class="mediatypes details"> @@ -2717,6 +2846,18 @@ <td>The flow identifier</td> </tr> + <tr> + <td></td> + <td>body</td> + + <td> + + <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> + </td> + + <td>The new versioned flow snapshot.</td> + </tr> + </tbody> </table> @@ -2742,12 +2883,24 @@ <td> + <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> + </td> <td>successful operation</td> </tr> <tr> + <td>400</td> + <td> + + string + + </td> + <td>NiFi Registry 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> @@ -2789,27 +2942,21 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> -</div> - </div> - + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/buckets/{bucketId} + </div> </div> - - -<div class="endpoints"> - <span class="path hidden">/buckets/{bucketId}/flows/{flowId}/versions/latest</span> + </div> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary" title="Get the latest version of a flow">Get the latest version of a flow</div> + <div class="summary" title="Gets summary information for all versions of a flow. Versions are ordered newest->oldest.">Gets summary information for all versions of a flow. Versions are ordered newest->oldest.</div> <div class="clear"></div> </div> @@ -2884,10 +3031,14 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> - - </td> - <td>successful operation</td> + + + array[<a class="type-link" href="javascript:void(0);">versionedFlowSnapshotMetadata</a>] + + + + </td> + <td>successful operation</td> </tr> <tr> @@ -2932,10 +3083,159 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + +</div> + </div> + + + +</div> + + +<div class="endpoints"> + <span class="path hidden">/buckets/{bucketId}/flows/{flowId}/versions/latest</span> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary" title="Get the latest version of a flow">Get the latest version of a flow</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>bucketId</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The bucket identifier</td> + </tr> + + <tr> + <td>flowId</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The flow identifier</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> + + + <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> + + + </td> + <td>successful operation</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>NiFi Registry was unable to complete the request because it assumes a server state that is not valid.</td> + </tr> + + </tbody> + </table> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + </div> </div> @@ -3027,7 +3327,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> + + <a class="type-link" href="javascript:void(0);">versionedFlowSnapshotMetadata</a> + </td> <td>successful operation</td> @@ -3075,10 +3377,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + </div> </div> @@ -3183,7 +3487,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> + + <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> + </td> <td>successful operation</td> @@ -3241,10 +3547,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + </div> </div> @@ -3296,7 +3604,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">Fields</a> + + <a class="type-link" href="javascript:void(0);">Fields</a> + </td> <td>successful operation</td> @@ -3304,10 +3614,7 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + </div> </div> @@ -3317,23 +3624,19 @@ <div class="endpoints"> - <span class="path hidden">/items</span> + <span class="path hidden">/flows/{flowId}</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary" title="Get items across all buckets">Get items across all buckets</div> + <div class="summary" title="Gets a flow">Gets a flow</div> <div class="clear"></div> </div> <div class="operation hidden"> - <div class="description"> - The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. - </div> - <div class="title">Request</div> <div class="mediatypes details"> @@ -3341,7 +3644,34 @@ </div> + <table> + <thead> + <tr> + <th>Name</th> + <th>Location</th> + <th>Type</th> + <th>Description</th> + </tr> + </thead> + <tbody> + + + <tr> + <td>flowId</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The flow identifier</td> + </tr> + + </tbody> + </table> <div class="title">Response</div> <div class="mediatypes details"> @@ -3364,12 +3694,24 @@ <td> + <a class="type-link" href="javascript:void(0);">versionedFlow</a> + </td> <td>successful operation</td> </tr> <tr> + <td>400</td> + <td> + + string + + </td> + <td>NiFi Registry 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> @@ -3379,12 +3721,44 @@ <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>NiFi Registry was unable to complete the request because it assumes a server state that is not valid.</td> + </tr> + </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + </div> </div> @@ -3394,14 +3768,14 @@ <div class="endpoints"> - <span class="path hidden">/items/fields</span> + <span class="path hidden">/flows/{flowId}/versions</span> <div class="endpoint get"> <div class="operation-handle"> <div class="method">GET</div> <div class="path mono"></div> - <div class="summary" title="Retrieves the available field names for searching or sorting on bucket items.">Retrieves the available field names for searching or sorting on bucket items.</div> + <div class="summary" title="Gets summary information for all versions of a flow. Versions are ordered newest->oldest.">Gets summary information for all versions of a flow. Versions are ordered newest->oldest.</div> <div class="clear"></div> </div> @@ -3414,9 +3788,574 @@ </div> - - - <div class="title">Response</div> + <table> + <thead> + <tr> + <th>Name</th> + <th>Location</th> + <th>Type</th> + <th>Description</th> + </tr> + </thead> + <tbody> + + + <tr> + <td>flowId</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The flow identifier</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> + + + + array[<a class="type-link" href="javascript:void(0);">versionedFlowSnapshotMetadata</a>] + + + + </td> + <td>successful operation</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>NiFi Registry was unable to complete the request because it assumes a server state that is not valid.</td> + </tr> + + </tbody> + </table> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + +</div> + </div> + + + +</div> + + +<div class="endpoints"> + <span class="path hidden">/flows/{flowId}/versions/latest</span> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary" title="Get the latest version of a flow">Get the latest version of a flow</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>flowId</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The flow identifier</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> + + + <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> + + + </td> + <td>successful operation</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>NiFi Registry was unable to complete the request because it assumes a server state that is not valid.</td> + </tr> + + </tbody> + </table> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + +</div> + </div> + + + +</div> + + +<div class="endpoints"> + <span class="path hidden">/flows/{flowId}/versions/latest/metadata</span> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary" title="Get the metadata for the latest version of a flow">Get the metadata for the latest version of a flow</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>flowId</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The flow identifier</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> + + + <a class="type-link" href="javascript:void(0);">versionedFlowSnapshotMetadata</a> + + + </td> + <td>successful operation</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>NiFi Registry was unable to complete the request because it assumes a server state that is not valid.</td> + </tr> + + </tbody> + </table> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + +</div> + </div> + + + +</div> + + +<div class="endpoints"> + <span class="path hidden">/flows/{flowId}/versions/{versionNumber}</span> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary" title="Gets the given version of a flow">Gets the given version of a flow</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>flowId</td> + <td>path</td> + + + + <td>string </td> + + + + <td>The flow identifier</td> + </tr> + + <tr> + <td>versionNumber</td> + <td>path</td> + + + + <td>integer (int32)</td> + + + + <td>The version number</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> + + + <a class="type-link" href="javascript:void(0);">versionedFlowSnapshot</a> + + + </td> + <td>successful operation</td> + </tr> + + <tr> + <td>400</td> + <td> + + string + + </td> + <td>NiFi Registry 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>NiFi Registry was unable to complete the request because it assumes a server state that is not valid.</td> + </tr> + + </tbody> + </table> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + +</div> + </div> + + + +</div> + + +<div class="endpoints"> + <span class="path hidden">/items</span> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary" title="Get items across all buckets">Get items across all buckets</div> + <div class="clear"></div> + </div> + +<div class="operation hidden"> + + <div class="description"> + The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. + </div> + + <div class="title">Request</div> + <div class="mediatypes details"> + + <div class="mediatype"><div class="title">consumes:</div><div class="mono">*/*</div><div class="clear"></div></div> + + </div> + + + + <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> @@ -3436,18 +4375,91 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">Fields</a> + + + array[<a class="type-link" href="javascript:void(0);">bucketItem</a>] + + </td> <td>successful operation</td> </tr> + <tr> + <td>401</td> + <td> + + string + + </td> + <td>Client could not be authenticated.</td> + </tr> + </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> + +</div> + </div> + + + +</div> + + +<div class="endpoints"> + <span class="path hidden">/items/fields</span> + + + <div class="endpoint get"> + <div class="operation-handle"> + <div class="method">GET</div> + <div class="path mono"></div> + <div class="summary" title="Retrieves the available field names for searching or sorting on bucket items.">Retrieves the available field names for searching or sorting on bucket items.</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> + + + + <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> + + + <a class="type-link" href="javascript:void(0);">Fields</a> + + + </td> + <td>successful operation</td> + </tr> + + </tbody> + </table> + </div> </div> @@ -3527,6 +4539,10 @@ <td> + + array[<a class="type-link" href="javascript:void(0);">bucketItem</a>] + + </td> <td>successful operation</td> @@ -3574,10 +4590,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/buckets/{bucketId} + </div> + </div> </div> @@ -3654,7 +4672,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">accessPolicy</a> + + <a class="type-link" href="javascript:void(0);">accessPolicy</a> + </td> <td>successful operation</td> @@ -3702,10 +4722,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/policies + </div> + </div> </div> @@ -3750,6 +4772,10 @@ <td> + + array[<a class="type-link" href="javascript:void(0);">accessPolicy</a>] + + </td> <td>successful operation</td> @@ -3787,10 +4813,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/policies + </div> + </div> </div> @@ -3843,6 +4871,10 @@ <td> + + array[<a class="type-link" href="javascript:void(0);">resource</a>] + + </td> <td>successful operation</td> @@ -3870,10 +4902,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/policies + </div> + </div> </div> @@ -3896,10 +4930,6 @@ <div class="operation hidden"> - <div class="description"> - Will return the effective policy if no specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned. - </div> - <div class="title">Request</div> <div class="mediatypes details"> @@ -3969,7 +4999,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">accessPolicy</a> + + <a class="type-link" href="javascript:void(0);">accessPolicy</a> + </td> <td>successful operation</td> @@ -4027,10 +5059,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/policies + </div> + </div> </div> @@ -4109,7 +5143,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">accessPolicy</a> + + <a class="type-link" href="javascript:void(0);">accessPolicy</a> + </td> <td>successful operation</td> @@ -4157,10 +5193,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/policies + </div> + </div> </div> @@ -4243,7 +5281,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">accessPolicy</a> + + <a class="type-link" href="javascript:void(0);">accessPolicy</a> + </td> <td>successful operation</td> @@ -4301,10 +5341,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/policies + </div> + </div> </div> @@ -4375,7 +5417,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">accessPolicy</a> + + <a class="type-link" href="javascript:void(0);">accessPolicy</a> + </td> <td>successful operation</td> @@ -4423,10 +5467,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: delete:/policies + </div> + </div> </div> @@ -4447,7 +5493,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -4505,7 +5551,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">userGroup</a> + + <a class="type-link" href="javascript:void(0);">userGroup</a> + </td> <td>successful operation</td> @@ -4563,10 +5611,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/tenants + </div> + </div> </div> @@ -4582,7 +5632,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -4615,6 +5665,10 @@ <td> + + array[<a class="type-link" href="javascript:void(0);">userGroup</a>] + + </td> <td>successful operation</td> @@ -4672,10 +5726,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/tenants + </div> + </div> </div> @@ -4699,7 +5755,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -4758,7 +5814,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">userGroup</a> + + <a class="type-link" href="javascript:void(0);">userGroup</a> + </td> <td>successful operation</td> @@ -4816,10 +5874,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/tenants + </div> + </div> </div> @@ -4835,7 +5895,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -4906,7 +5966,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">userGroup</a> + + <a class="type-link" href="javascript:void(0);">userGroup</a> + </td> <td>successful operation</td> @@ -4964,10 +6026,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/tenants + </div> + </div> </div> @@ -4983,7 +6047,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -5042,7 +6106,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">userGroup</a> + + <a class="type-link" href="javascript:void(0);">userGroup</a> + </td> <td>successful operation</td> @@ -5100,10 +6166,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: delete:/tenants + </div> + </div> </div> @@ -5124,7 +6192,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -5182,7 +6250,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">user</a> + + <a class="type-link" href="javascript:void(0);">user</a> + </td> <td>successful operation</td> @@ -5240,10 +6310,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/tenants + </div> + </div> </div> @@ -5259,7 +6331,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -5292,6 +6364,10 @@ <td> + + array[<a class="type-link" href="javascript:void(0);">user</a>] + + </td> <td>successful operation</td> @@ -5339,10 +6415,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/tenants + </div> + </div> </div> @@ -5366,7 +6444,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -5425,7 +6503,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">user</a> + + <a class="type-link" href="javascript:void(0);">user</a> + </td> <td>successful operation</td> @@ -5483,10 +6563,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: read:/tenants + </div> + </div> </div> @@ -5502,7 +6584,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -5573,7 +6655,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">user</a> + + <a class="type-link" href="javascript:void(0);">user</a> + </td> <td>successful operation</td> @@ -5631,10 +6715,12 @@ </tbody> </table> - <div class="title">Authorization</div> - <div class="authorization details"> - - </div> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: write:/tenants + </div> + </div> </div> @@ -5650,7 +6736,7 @@ <div class="operation hidden"> <div class="description"> - Note: This endpoint is subject to change as NiFi and its REST API evolve. + Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. </div> <div class="title">Request</div> @@ -5709,7 +6795,9 @@ <td>200</td> <td> - <a class="type-link" href="javascript:void(0);">user</a> + + <a class="type-link" href="javascript:void(0);">user</a> + </td> <td>successful operation</td> @@ -5765,22 +6853,168 @@ <td>NiFi Registry was unable to complete the request because it assumes a server state that is not valid.</td> </tr> - </tbody> - </table> - <div class="title">Authorization</div> - <div class="authorization details"> - + </tbody> + </table> + + <div class="title">Authorization</div> + <div class="authorization details"> + Requires access policy: delete:/tenants + </div> + +</div> + </div> + +</div> + + </div> + + +<div id="BatchSize" class="type hidden"> + <h3>BatchSize</h3> + <div class="type-container"> + <table> + <tr> + <th>Name</th> + <th>Type</th> + <th>Required</th> + <th>Description</th> + </tr> + + <tr> + <td>count</td> + <td> + + + + integer (int32) + + + </td> + <td>optional</td> + <td>Preferred number of flow files to include in a transaction. + + </td> + </tr> + + <tr> + <td>size</td> + <td> + + + + string + + + </td> + <td>optional</td> + <td>Preferred number of bytes to include in a transaction. + + </td> + </tr> + + <tr> + <td>duration</td> + <td> + + + + string + + + </td> + <td>optional</td> + <td>Preferred amount of time that a transaction should span. + + </td> + </tr> + + </table> + <h4>Example JSON</h4> + <code class="example"><span class="open-object">{ + "count": 0<span class="comma">,</span> + "size": "value"<span class="comma">,</span> + "duration": "value"<span class="comma">,</span> +}</span></code> + </div> + <div class="close">Close</div> + <div class="clear"></div> +</div> + + +<div id="Bundle" class="type hidden"> + <h3>Bundle</h3> + <div class="type-container"> + <table> + <tr> + <th>Name</th> + <th>Type</th> + <th>Required</th> + <th>Description</th> + </tr> + + <tr> + <td>group</td> + <td> + + + + string + + + </td> + <td>optional</td> + <td>The group of the bundle + + </td> + </tr> + + <tr> + <td>artifact</td> + <td> + + + + string + + + </td> + <td>optional</td> + <td>The artifact of the bundle + + </td> + </tr> + + <tr> + <td>version</td> + <td> + + + + string + + + </td> + <td>optional</td> + <td>The version of the bundle + + </td> + </tr> + + </table> + <h4>Example JSON</h4> + <code class="example"><span class="open-object">{ + "group": "value"<span class="comma">,</span> + "artifact": "value"<span class="comma">,</span> + "version": "value"<span class="comma">,</span> +}</span></code> </div> + <div class="close">Close</div> + <div class="clear"></div> </div> - </div> - -</div> - - </div> -<div id="BatchSize" class="type hidden"> - <h3>BatchSize</h3> +<div id="ComponentDifference" class="type hidden"> + <h3>ComponentDifference</h3> <div class="type-container"> <table> <tr> @@ -5791,23 +7025,23 @@ </tr> <tr> - <td>count</td> + <td>valueA</td> <td> - integer (int32) + string </td> <td>optional</td> - <td>Preferred number of flow files to include in a transaction. + <td>The earlier value from the difference. </td> </tr> <tr> - <td>size</td> + <td>valueB</td> <td> @@ -5817,13 +7051,13 @@ </td> <td>optional</td> - <td>Preferred number of bytes to include in a transaction. + <td>The newer value from the difference. </td> </tr> <tr> - <td>duration</td> + <td>changeDescription</td> <td> @@ -5833,7 +7067,39 @@ </td> <td>optional</td> - <td>Preferred amount of time that a transaction should span. + <td>The description of the change. + + </td> + </tr> + + <tr> + <td>differenceType</td> + <td> + + + + string + + + </td> + <td>optional</td> + <td>The key to the difference. + + </td> + </tr> + + <tr> + <td>differenceTypeDescription</td> + <td> + + + + string + + + </td> + <td>optional</td> + <td>The description of the change type. </td> </tr> @@ -5841,9 +7107,11 @@ </table> <h4>Example JSON</h4> <code class="example"><span class="open-object">{ - "count": 0<span class="comma">,</span> - "size": "value"<span class="comma">,</span> - "duration": "value"<span class="comma">,</span> + "valueA": "value"<span class="comma">,</span> + "valueB": "value"<span class="comma">,</span> + "changeDescription": "value"<span class="comma">,</span> + "differenceType": "value"<span class="comma">,</span> + "differenceTypeDescription": "value"<span class="comma">,</span> }</span></code> </div> <div class="close">Close</div> @@ -5851,8 +7119,8 @@ </div> -<div id="Bundle" class="type hidden"> - <h3>Bundle</h3> +<div id="ComponentDifferenceGroup" class="type hidden"> + <h3>ComponentDifferenceGroup</h3> <div class="type-container"> <table> <tr> @@ -5863,7 +7131,7 @@ </tr> <tr> - <td>group</td> + <td>componentId</td> <td> @@ -5873,13 +7141,13 @@ </td> <td>optional</td> - <td>The group of the bundle + <td>The id of the component whose changes are grouped together. </td> </tr> <tr> - <td>artifact</td> + <td>componentName</td> <td> @@ -5889,13 +7157,13 @@ </td> <td>optional</td> - <td>The artifact of the bundle + <td>The name of the component whose changes are grouped together. </td> </tr> <tr> - <td>version</td> + <td>componentType</td> <td> @@ -5905,7 +7173,39 @@ </td> <td>optional</td> - <td>The version of the bundle + <td>The type of component these changes relate to. + + </td> + </tr> + + <tr> + <td>processGroupId</td> + <td> + + + + string + + + </td> + <td>optional</td> + <td>The process group id for this component. + + </td> + </tr> + + <tr> + <td>differences</td> + <td> + + + array[<a class="type-link" href="javascript:void(0);">ComponentDifference</a>] + + + + </td> + <td>optional</td> + <td>The list of changes related to this component between the 2 versions. </td> </tr> @@ -5913,9 +7213,11 @@ </table> <h4>Example JSON</h4> <code class="example"><span class="open-object">{ - "group": "value"<span class="comma">,</span> - "artifact": "value"<span class="comma">,</span> - "version": "value"<span class="comma">,</span> + "componentId": "value"<span class="comma">,</span> + "componentName": "value"<span class="comma">,</span> + "componentType": "value"<span class="comma">,</span> + "processGroupId": "value"<span class="comma">,</span> + "differences": [<span class="nested collapsed"><span class="nested-id hidden">ComponentDifference</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span> }</span></code> </div> <div class="close">Close</div> @@ -6150,12 +7452,12 @@ </tr> <tr> - <td>params</td> + <td>title</td> <td> - object + string </td> @@ -6166,12 +7468,12 @@ </tr> <tr> - <td>title</td> + <td>params</td> <td> - string + object </td> @@ -6182,12 +7484,12 @@ </tr> <tr> - <td>rel</td> + <td>uri</td> <td> - string + string (uri) </td> @@ -6198,12 +7500,12 @@ </tr> <tr> - <td>uri</td> + <td>uriBuilder</td> <td> + <a class="type-link" href="javascript:void(0);">UriBuilder</a> - string (uri) </td> @@ -6214,12 +7516,12 @@ </tr> <tr> - <td>uriBuilder</td> + <td>rel</td> <td> - <a class="type-link" href="javascript:void(0);">UriBuilder</a> + string </td> @@ -6249,13 +7551,13 @@ <h4>Example JSON</h4> <code class="example"><span class="open-object">{ "type": "value"<span class="comma">,</span> + "title": "value"<span class="comma">,</span> "params": <span class="open-object">{ "name": "value" }</span><span class="comma">,</span> - "title": "value"<span class="comma">,</span> - "rel": "value"<span class="comma">,</span> "uri": "value"<span class="comma">,</span> "uriBuilder": <span class="nested collapsed"><span class="nested-id hidden">UriBuilder</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span> + "rel": "value"<span class="comma">,</span> "rels": ["value"]<span class="comma">,</span> }</span></code> </div> @@ -6264,8 +7566,8 @@ </div> -<div id="The position of a component on the graph" class="type hidden"> - <h3>The position of a component on the graph</h3> +<div id="Position" class="type hidden"> + <h3>Position</h3> <div class="type-container"> <table> <tr> @@ -6404,7 +7706,7 @@ <td> - <a class="type-link" href="javascript:void(0);">The position of a component on the graph</a> + <a class="type-link" href="javascript:void(0);">Position</a> @@ -6464,7 +7766,7 @@ </tr> <tr> - <td>getzIndex</td> + <td>zIndex</td> <td> @@ -6564,7 +7866,7 @@ <td> - array[<a class="type-link" href="javascript:void(0);">The position of a component on the graph</a>] + array[<a class="type-link" href="javascript:void(0);">Position</a>] @@ -6613,17 +7915,17 @@ "identifier": "value"<span class="comma">,</span> "name": "value"<span class="comma">,</span> "comments": "value"<span class="comma">,</span> - "position": <span class="nested collapsed"><span class="nested-id hidden">The position of a component on the graph</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span> + "position": <span class="nested collapsed"><span class="nested-id hidden">Position</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span> "source": <span class="nested collapsed"><span class="nested-id hidden">ConnectableComponent</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span> "destination": <span class="nested collapsed"><span class="nested-id hidden">ConnectableComponent</span><span class="nested-example"><span class="open-object">{…}</span></span></span><span class="comma">,</span> "labelIndex": 0<span class="comma">,</span> - "getzIndex": 0<span class="comma">,</span> + "zIndex": 0<span class="comma">,</span> "selectedRelationships": ["value"]<span class="comma">,</span> "backPressureObjectThreshold": 0<span class="comma">,</span> "backPressureDataSizeThreshold": "value"<span class="comma">,</span> "flowFileExpiration": "value"<span class="comma">,</span> "prioritizers": ["value"]<span class="comma">,</span> - "bends": [<span class="nested collapsed"><span class="nested-id hidden">The position of a component on the graph</span><span class="nested-example"><span class="open-object">{…}</span></span></span>]<span class="comma">,</span>
[... 933 lines stripped ...]
