Google Git
Sign in
apache / falcon / refs/heads/asf-site / . / content / 0.11 / restapi / MetadataRelations.html
blob: ce6a55c98db473a236d5b713c8498b861faeb39e [file] [log] [blame]
<!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/metadata/discovery/:dimension-type/:dimension-name/relations</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/metadata/discovery/:dimension-type/:dimension-name/relations</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/metadata/discovery/:dimension-type/:dimension-name/relations<a name="GET_apimetadatadiscovery:dimension-type:dimension-namerelations"></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 all relations of a specific dimension.</p></div>
<div class="section">
<h3>Parameters<a name="Parameters"></a></h3>
<p></p>
<ul>
<li>:type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines</li>
<li>:name Name of the dimension.</li>
<li>doAs &lt;optional query param&gt; allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div>
<div class="section">
<h3>Results<a name="Results"></a></h3>
<p>Get all relations of a specific dimension.</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/metadata/discovery/process_entity/sample-process/relations?doAs=joe
</pre></div></div>
<div class="section">
<h4>Result<a name="Result"></a></h4>
<div class="source">
<pre>
{
&quot;timestamp&quot;:&quot;2014-09-09T01:31Z&quot;,
&quot;userWorkflowEngine&quot;:&quot;pig&quot;,
&quot;name&quot;:&quot;sample-process&quot;,
&quot;type&quot;:&quot;PROCESS_ENTITY&quot;,
&quot;userWorkflowName&quot;:&quot;imp-click-join-workflow&quot;,
&quot;version&quot;:&quot;1.0.9&quot;,
&quot;inVertices&quot;:[
{&quot;name&quot;:&quot;clicks-feed&quot;,&quot;type&quot;:&quot;FEED_ENTITY&quot;,&quot;label&quot;:&quot;input&quot;},
{&quot;name&quot;:&quot;impression-feed&quot;,&quot;type&quot;:&quot;FEED_ENTITY&quot;,&quot;label&quot;:&quot;input&quot;},
{&quot;name&quot;:&quot;sample-process\/2014-01-01T01:00Z&quot;,&quot;type&quot;:&quot;PROCESS_INSTANCE&quot;,&quot;label&quot;:&quot;instance-of&quot;}
],
&quot;outVertices&quot;:[
{&quot;name&quot;:&quot;Critical&quot;,&quot;type&quot;:&quot;TAGS&quot;,&quot;label&quot;:&quot;classified-as&quot;},
{&quot;name&quot;:&quot;testPipeline&quot;,&quot;type&quot;:&quot;PIPELINES&quot;,&quot;label&quot;:&quot;pipeline&quot;},
{&quot;name&quot;:&quot;primary-cluster&quot;,&quot;type&quot;:&quot;CLUSTER_ENTITY&quot;,&quot;label&quot;:&quot;runs-on&quot;},
{&quot;name&quot;:&quot;imp-click-join2&quot;,&quot;type&quot;:&quot;FEED_ENTITY&quot;,&quot;label&quot;:&quot;output&quot;},
{&quot;name&quot;:&quot;imp-click-join1&quot;,&quot;type&quot;:&quot;FEED_ENTITY&quot;,&quot;label&quot;:&quot;output&quot;},
{&quot;name&quot;:&quot;falcon-user&quot;,&quot;type&quot;:&quot;USER&quot;,&quot;label&quot;:&quot;owned-by&quot;}
]
}
</pre></div></div>
</div>
</div>
<hr/>
<footer>
<div class="container">
<div class="row span12">Copyright &copy; 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>