| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 2018-03-12 |
| | Rendered using Apache Maven Fluido Skin 1.3.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20180312" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Falcon - GET /api/entities/list/{:entity-type}</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> |
| |
| |
| |
| <script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> |
| |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| |
| <div class="container"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> |
| </div> |
| </div> |
| <div class="pull-right"> </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li class=""> |
| <a href="../index.html" title="Falcon"> |
| Falcon</a> |
| </li> |
| <li class="divider ">/</li> |
| <li class="">GET /api/entities/list/{:entity-type}</li> |
| |
| |
| |
| <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> |
| <li id="projectVersion" class="pull-right">Version: 0.11</li> |
| |
| </ul> |
| </div> |
| |
| |
| |
| <div id="bodyColumn" > |
| |
| <div class="section"> |
| <h3>GET /api/entities/list/{:entity-type}<a name="GET_apientitieslist:entity-type"></a></h3> |
| <p></p> |
| <ul> |
| <li><a href="#Description">Description</a></li> |
| <li><a href="#Parameters">Parameters</a></li> |
| <li><a href="#Results">Results</a></li> |
| <li><a href="#Examples">Examples</a></li></ul></div> |
| <div class="section"> |
| <h3>Description<a name="Description"></a></h3> |
| <p>Get list of the entities.</p></div> |
| <div class="section"> |
| <h3>Parameters<a name="Parameters"></a></h3> |
| <p></p> |
| <ul> |
| <li>:entity-type <optional param> Comma-separated entity types. Valid entity types are cluster, feed or process.</li> |
| <li>fields <optional param> Fields of entity that the user wants to view, separated by commas. |
| <ul> |
| <li>Valid options are STATUS, TAGS, PIPELINES, CLUSTERS.</li></ul></li> |
| <li>nameseq <optional param> Subsequence of entity name. Not case sensitive. |
| <ul> |
| <li>The entity name needs to contain all the characters in the subsequence in the same order.</li> |
| <li>Example 1: "sample1" will match the entity named "SampleFeed1-2".</li> |
| <li>Example 2: "mhs" will match the entity named "New-My-Hourly-Summary".</li></ul></li> |
| <li>tagkeys <optional param> Keywords in tags, separated by comma. Not case sensitive. |
| <ul> |
| <li>The returned entities will have tags that match all the tag keywords.</li></ul></li> |
| <li>filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,PIPELINES:clickLogs |
| <ul> |
| <li>Supported filter fields are NAME, STATUS, PIPELINES, CLUSTER.</li> |
| <li>Query will do an AND among filterBy fields.</li></ul></li> |
| <li>tags <optional param> Return list of entities that have specified tags, separated by a comma. Query will do AND on tag values. |
| <ul> |
| <li>Example: tags=consumer=consumer@xyz.com,owner=producer@xyz.com</li></ul></li> |
| <li>orderBy <optional param> Field by which results should be ordered. |
| <ul> |
| <li>Supports ordering by "name".</li></ul></li> |
| <li>sortOrder <optional param> Valid options are "asc" and "desc"</li> |
| <li>offset <optional param> Show results from the offset, used for pagination. Defaults to 0.</li> |
| <li>numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.</li> |
| <li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li> |
| <li>Note: |
| <ul> |
| <li>We have two filtering parameters for entity tags: "tags" and "tagkeys". "tags" does the exact match in key=value fashion, while "tagkeys" finds all the entities with the given key as a substring in the tags. This "tagkeys" filter is introduced for the user who doesn't remember the exact tag but some keywords in the tag. It also helps users to save the time of typing long tags.</li> |
| <li>The returned entities will match all the filtering criteria.</li></ul></li></ul></div> |
| <div class="section"> |
| <h3>Results<a name="Results"></a></h3> |
| <p>Total number of results and a list of entities.</p></div> |
| <div class="section"> |
| <h3>Examples<a name="Examples"></a></h3></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| GET http://localhost:15000/api/entities/list |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "totalResults":"4”, |
| "entity": [ |
| { |
| "name" : "SampleCluster1", |
| "type" : "cluster" |
| } |
| { |
| "name" : "SampleOutput", |
| "type" : "feed" |
| }, |
| { |
| "name" : "SampleInput", |
| "type" : "feed" |
| } |
| { |
| "name" : "SampleProcess1", |
| "type" : "process" |
| } |
| ] |
| } |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| GET http://localhost:15000/api/entities/list/feed |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "totalResults":"2”, |
| "entity": [ |
| { |
| "name": "SampleOutput", |
| "type": "feed" |
| }, |
| { |
| "name": "SampleInput", |
| "type": "feed" |
| } |
| ] |
| } |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| GET http://localhost:15000/api/entities/list/feed?fields=status |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "totalResults":"2”, |
| "entity": [ |
| { |
| "name" : "SampleOutput", |
| "type" : "feed", |
| "status": "RUNNING" |
| }, |
| { |
| "name": "SampleInput", |
| "type": "feed", |
| "status": "RUNNING" |
| } |
| ] |
| } |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| GET http://localhost:15000/api/entities/list/process?filterBy=STATUS:RUNNING,PIPELINES:dataReplication&fields=status,pipelines,tags&tags=consumer=consumer@xyz.com&orderBy=name&offset=2&numResults=2 |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "totalResults":"10”, |
| "entity": [ |
| { |
| "name" : "SampleProcess1", |
| "type" : "process", |
| "status": "RUNNING", |
| "pipelines": "dataReplication", |
| "tags": "consumer=consumer@xyz.com" |
| }, |
| { |
| "name": "SampleProcess3", |
| "type": "process", |
| "status": "RUNNING", |
| "pipelines": "dataReplication", |
| "tags": "consumer=consumer@xyz.com,owner=producer@xyz.com" |
| } |
| ] |
| } |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| GET http://localhost:15000/api/entities/list/feed,process?nameseq=samplebill&tagkeys=billing,healthcare&numResults=2&offset=1&fields=status,clusters,tags&doAs=joe |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "totalResults":"4”, |
| "entity”:[ |
| { |
| "type":"FEED”, |
| "name":"SampleUSHealthBill”, |
| "status":"SUBMITTED”, |
| "tags”: {"tag":["related=ushealthcare","department=billingDepartment"]}, |
| "clusters": {"cluster":["SampleCluster1","primaryCluster”]} |
| }, |
| { |
| "type":"PROCESS”, |
| "name":"SampleHealthBill”, |
| "status":"SUBMITTED”, |
| "tags”: {"tag":["related=healthcare","department=billingDepartment"]}, |
| "clusters": {"cluster":"primaryCluster”} |
| } |
| ] |
| } |
| |
| </pre></div></div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container"> |
| <div class="row span12">Copyright © 2013-2018 |
| <a href="http://www.apache.org">Apache Software Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| <p id="poweredBy" class="pull-right"> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> |
| </a> |
| </p> |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
