You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by ba...@apache.org on 2016/08/08 23:16:07 UTC
[33/49] falcon git commit: FALCON-2006 Update documentation on site
for 0.10 release
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/InstanceResume.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/InstanceResume.html b/content/0.10/restapi/InstanceResume.html
new file mode 100644
index 0000000..cd25a9b
--- /dev/null
+++ b/content/0.10/restapi/InstanceResume.html
@@ -0,0 +1,140 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/instance/resume/:entity-type/:entity-name</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="">POST /api/instance/resume/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/instance/resume/:entity-type/:entity-name<a name="POST_apiinstanceresume:entity-type:entity-name"></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>Resume suspended instances of an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can either be a feed or a process.</li>
+<li>:entity-name is name of the entity.</li>
+<li>start is the start time of the instance(s) that you want to refer to</li>
+<li>end is the end time of the instance(s) that you want to refer to</li>
+<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li>
+<li>doAs <optional query param> 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>Results of the resume command.</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>
+ POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z&doAs=joe
+
+</pre></div>
+<p>---+++ Result</p>
+<div class="source">
+<pre>
+ {
+ "instances": [
+ {
+ "details": "",
+ "startTime": "2013-10-21T15:19:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/e88ff2e0-2af7-4829-a360-f92e95be2981\n",
+ "message": "default\/RESUME\n",
+ "status": "SUCCEEDED"
+ }
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/InstanceRunning.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/InstanceRunning.html b/content/0.10/restapi/InstanceRunning.html
new file mode 100644
index 0000000..3a14211
--- /dev/null
+++ b/content/0.10/restapi/InstanceRunning.html
@@ -0,0 +1,187 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/instance/running/:entity-type/:entity-name</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/instance/running/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/instance/running/:entity-type/:entity-name<a name="GET_apiinstancerunning:entity-type:entity-name"></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 a list of instances currently running for a given entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type Valid options are cluster, feed or process.</li>
+<li>:entity-name Name of the entity.</li>
+<li>colo <optional param> Colo on which the query should be run.</li>
+<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li>
+<li>filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=CLUSTER:primary-cluster
+<ul>
+<li>Supported filter fields are CLUSTER, SOURCECLUSTER, STARTEDAFTER.</li>
+<li>Query will do an AND among filterBy fields.</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered.
+<ul>
+<li>Supports ordering by "status","startTime","endTime","cluster".</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></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>List of instances currently running.</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/instance/running/process/SampleProcess?colo=*
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "startTime": "2013-10-21T14:39:28-07:00",
+ "cluster": "primary-cluster",
+ "status": "RUNNING",
+ "instance": "2012-04-03T06:00Z"
+ }
+ ],
+ "requestId": "default\/12e9a7d4-3b4f-4a76-b471-c8f3786a62a0\n",
+ "message": "default\/Running Instances\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2&doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:42:27-07:00",
+ "startTime": "2013-10-21T14:41:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T08:00Z"
+ },
+ ],
+
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/InstanceSearch.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/InstanceSearch.html b/content/0.10/restapi/InstanceSearch.html
new file mode 100644
index 0000000..513e273
--- /dev/null
+++ b/content/0.10/restapi/InstanceSearch.html
@@ -0,0 +1,206 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/instance/search</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/instance/search</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/instance/search<a name="GET_apiinstancesearch"></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 the list of instances that meet search criteria.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:type <optional param> Comma-separated entity types. Valid entity types are feed, process or datasource.</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>instanceStatus <optional param> Valid options are RUNNING, SUCCEEDED, FAILED, WAITING, SUSPENDED, KILLED, TIMEOUT.</li>
+<li>start <optional param> Show instances from this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>By default, it is set to (end - (10 * entityFrequency)).</li></ul></li>
+<li>end <optional param> Show instances up to this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>Default is set to now.</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered. Sorted by descending order.
+<ul>
+<li>If not specified, instances of the same entity will be listed together in the result.</li>
+<li>Current valid option: status. Coming soon: sorting by name, nominal time, running time.</li></ul></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.
+<ul>
+<li>Only integers > 0 are valid. Default is 10.</li></ul></li>
+<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>A list of instances.</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/instance/search?nameseq=usbill&start=2012-04-03T00:00Z
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ “name":"SampleUSHealthBill”,
+ “type":"FEED”,
+ “tags”: {"tag":["related=ushealthcare","department=billingDepartment"]},
+ “nominalTime": "2012-04-03T07:00Z"
+ "cluster": "primary-cluster",
+ "status": "SUCCEEDED",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ }
+ ],
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "Instances Search Results",
+ "status": "SUCCEEDED”
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/instance/search?nameseq=samplebill&tagkeys=billing,healthcare&start=2012-04-03T00:00Z&instanceStatus=succeeded&orderBy=nominalTime&offset=2&numResults=2
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+ {
+ "instances": [
+ {
+ "name":"SampleHealthBill",
+ "type":"PROCESS",
+ "tags”: {"tag":["related=healthcare","department=billingDepartment"]},
+ “nominalTime": "2012-04-03T08:00Z"
+ "cluster": "primary-cluster",
+ "status": "SUCCEEDED",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "startTime": "2013-10-21T14:41:56-07:00",
+ "endTime": "2013-10-21T14:42:26-07:00",
+ },
+ {
+ "name":"SampleUSHealthBill",
+ "type":"FEED”,
+ "tags": {"tag":["related=ushealthcare","department=billingDepartment"]},
+ “nominalTime": "2012-04-03T07:00Z"
+ "cluster": "primary-cluster",
+ "status": "SUCCEEDED",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ },
+ ],
+
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "Instances Search Results",
+ "status": "SUCCEEDED”
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/InstanceStatus.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/InstanceStatus.html b/content/0.10/restapi/InstanceStatus.html
new file mode 100644
index 0000000..013efde
--- /dev/null
+++ b/content/0.10/restapi/InstanceStatus.html
@@ -0,0 +1,204 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/instance/status/:entity-type/:entity-name</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/instance/status/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/instance/status/:entity-type/:entity-name<a name="GET_apiinstancestatus:entity-type:entity-name"></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 status of a specific instance of an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type Valid options are cluster, feed or process.</li>
+<li>:entity-name Name of the entity.</li>
+<li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>By default, it is set to (end - (10 * entityFrequency)).</li></ul></li>
+<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>Default is set to now.</li></ul></li>
+<li>colo <optional param> Colo on which the query should be run.</li>
+<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li>
+<li>filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+<ul>
+<li>Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.</li>
+<li>Query will do an AND among filterBy fields.</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered.
+<ul>
+<li>Supports ordering by "status","startTime","endTime","cluster".</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>allAttempts <optional query param> To get all the attempts for corresponding instances.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Status of the specified instance along with job urls for all actions of user workflow and non-succeeded actions of the main-workflow.</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 https://localhost:15443/api/instance/status/process/WordCount?start=2014-11-04T16:00Z&colo=*
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2014-11-05T16:08:10+05:30",
+ "startTime": "2014-11-05T16:07:29+05:30",
+ "cluster": "local",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000011-141105155430303-oozie-oozi-W",
+ "status": "SUCCEEDED",
+ "instance": "2014-11-04T16:00Z",
+ "actions": [
+ {
+ "action": "wordcount-mr",
+ "status": "SUCCEEDED",
+ "logFile": "http:\/\/localhost:50030\/jobdetails.jsp?jobid=job_201411051553_0005"
+ }
+ ]
+ }
+ ],
+ "requestId": "default\/b9fc3cba-1b46-4d1f-8196-52c795ea3580\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2&doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:42:26-07:00",
+ "startTime": "2013-10-21T14:41:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T08:00Z"
+ },
+ ],
+
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/InstanceSummary.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/InstanceSummary.html b/content/0.10/restapi/InstanceSummary.html
new file mode 100644
index 0000000..ca7acad
--- /dev/null
+++ b/content/0.10/restapi/InstanceSummary.html
@@ -0,0 +1,219 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/instance/summary/:entity-type/:entity-name</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/instance/summary/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/instance/summary/:entity-type/:entity-name<a name="GET_apiinstancesummary:entity-type:entity-name"></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 summary of instance/instances of an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type Valid options are feed or process.</li>
+<li>:entity-name Name of the entity.</li>
+<li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.</li></ul>* By default, it is set to (end - (10 * entityFrequency)).
+<ul>
+<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.</li></ul>* Default is set to now.
+<ul>
+<li>colo <optional param> Colo on which the query should be run.</li>
+<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li>
+<li>filterBy <optional param> Filter results by list of field:value pairs.</li></ul>Example1: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster Example2: filterBy=Status:RUNNING,Status:KILLED * Supported filter fields are STATUS, CLUSTER * Query will do an AND among filterBy fields.
+<ul>
+<li>orderBy <optional param> Field by which results should be ordered.</li></ul>* Supports ordering by "cluster".
+<ul>
+<li>sortOrder <optional param> Valid options are "asc" and "desc"</li></ul>Example: orderBy=cluster sortOrder=asc
+<ul>
+<li>doAs <optional query param> 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>Summary of the instances over the specified time range</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/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "status":"SUCCEEDED",
+ "message":"default/SUMMARY\n",
+ "requestId":"default/c344567b-da73-44d5-bcd4-bf456524934c\n",
+ "instancesSummary":
+ {
+ "cluster":"local",
+ "map":
+ {
+ "entry":
+ {
+ "key":"SUCCEEDED",
+ "value":"value"
+ }
+ }
+ }
+ }
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET https://localhost:16443/api/instance/summary/process/WordCount?filterBy=Status:KILLED,Status:RUNNING&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=*
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "status":"SUCCEEDED",
+ "message":"local/SUMMARY\n",
+ "requestId":"local/1246061948@qtp-1059149611-5 - 34d8c3bb-f461-4fd5-87cd-402c9c6b1ed2\n",
+ "instancesSummary":[
+ {
+ "cluster":"local",
+ "map":{
+ "entry":{
+ "key":"RUNNING",
+ "value":"1"
+ },
+ "entry":{
+ "key":"KILLED",
+ "value":"1"
+ }
+ }
+ }
+ ]
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET https://localhost:16443/api/instance/summary/process/WordCount?orderBy=cluster&sortOrder=asc&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=*&doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "status":"SUCCEEDED",
+ "message":"local/SUMMARY\n",
+ "requestId":"local/1246061948@qtp-1059149611-5 - 42e2040d-6b6e-4bfd-a090-83db5ed1a429\n",
+ "instancesSummary":[
+ {
+ "cluster":"local",
+ "map":{
+ "entry":{
+ "key":"SUCCEEDED",
+ "value":"6"
+ },
+ "entry":{
+ "key":"KILLED",
+ "value":"1"
+ }
+ }
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/InstanceSuspend.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/InstanceSuspend.html b/content/0.10/restapi/InstanceSuspend.html
new file mode 100644
index 0000000..59d590b
--- /dev/null
+++ b/content/0.10/restapi/InstanceSuspend.html
@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/instance/suspend/:entity-type/:entity-name</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="">POST /api/instance/suspend/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/instance/suspend/:entity-type/:entity-name<a name="POST_apiinstancesuspend:entity-type:entity-name"></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>Suspend instances of an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can either be a feed or a process.</li>
+<li>:entity-name is name of the entity.</li>
+<li>start is the start time of the instance(s) that you want to refer to</li>
+<li>end is the end time of the instance(s) that you want to refer to</li>
+<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li>
+<li>doAs <optional query param> 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>Results of the suspend command.</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>
+POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z&doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T15:15:01-07:00",
+ "startTime": "2013-10-21T15:14:32-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/ff07e45b-b6da-4f47-ae96-9182bd8a7e53\n",
+ "message": "default\/SUSPEND\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/MetadataList.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/MetadataList.html b/content/0.10/restapi/MetadataList.html
new file mode 100644
index 0000000..cdd0f71
--- /dev/null
+++ b/content/0.10/restapi/MetadataList.html
@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/metadata/discovery/:type/list</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/:type/list</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/metadata/discovery/:type/list<a name="GET_apimetadatadiscovery:typelist"></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 dimensions of specified type.</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>cluster <optional query param> Show dimensions related to this cluster.</li>
+<li>doAs <optional query param> 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>List of dimensions that match requested type [and cluster].</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/list?cluster=primary-cluster&doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results": ["sampleIngestProcess","testProcess","anotherProcess"],
+ "totalSize": 3
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/MetadataRelations.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/MetadataRelations.html b/content/0.10/restapi/MetadataRelations.html
new file mode 100644
index 0000000..ba83ea0
--- /dev/null
+++ b/content/0.10/restapi/MetadataRelations.html
@@ -0,0 +1,144 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <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: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</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 <optional query param> 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>
+{
+ "timestamp":"2014-09-09T01:31Z",
+ "userWorkflowEngine":"pig",
+ "name":"sample-process",
+ "type":"PROCESS_ENTITY",
+ "userWorkflowName":"imp-click-join-workflow",
+ "version":"1.0.9",
+ "inVertices":[
+ {"name":"clicks-feed","type":"FEED_ENTITY","label":"input"},
+ {"name":"impression-feed","type":"FEED_ENTITY","label":"input"},
+ {"name":"sample-process\/2014-01-01T01:00Z","type":"PROCESS_INSTANCE","label":"instance-of"}
+ ],
+ "outVertices":[
+ {"name":"Critical","type":"TAGS","label":"classified-as"},
+ {"name":"testPipeline","type":"PIPELINES","label":"pipeline"},
+ {"name":"primary-cluster","type":"CLUSTER_ENTITY","label":"runs-on"},
+ {"name":"imp-click-join2","type":"FEED_ENTITY","label":"output"},
+ {"name":"imp-click-join1","type":"FEED_ENTITY","label":"output"},
+ {"name":"falcon-user","type":"USER","label":"owned-by"}
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ResourceList.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/ResourceList.html b/content/0.10/restapi/ResourceList.html
new file mode 100644
index 0000000..cf32f1d
--- /dev/null
+++ b/content/0.10/restapi/ResourceList.html
@@ -0,0 +1,395 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - RESTful Resources</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="">RESTful Resources</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h2>RESTful Resources<a name="RESTful_Resources"></a></h2></div>
+<div class="section">
+<h3>Resource List<a name="Resource_List"></a></h3>
+<p></p>
+<ul>
+<li><a href="#REST_Call_on_Entity_Resource">REST Call on Entity Resource</a></li>
+<li><a href="#REST_Call_on_Feed_and_Process_Instances">REST Call on Feed/Process Instances</a></li>
+<li><a href="#REST_Call_on_Admin_Resource">REST Call on Admin Resource</a></li>
+<li><a href="#REST_Call_on_Lineage_Graph">REST Call on Lineage Graph Resource</a></li>
+<li><a href="#REST_Call_on_Metadata_Resource">REST Call on Metadata Resource</a></li>
+<li><a href="#REST_Call_on_Extension_Artifact">REST Call on Extension artifact</a></li>
+<li><a href="#REST_Call_on_Extension_Job Management">REST Call on Extension Job Management</a></li></ul></div>
+<div class="section">
+<h3>Authentication<a name="Authentication"></a></h3>
+<p>When security is off (Pseudo/Simple), the authenticated user is the username specified in the user.name query parameter. If the user.name parameter is not set, the server may either set the authenticated user to a default web user, if there is any, or return an error response.</p>
+<p>When security is on (kerberos), authentication is performed by Kerberos SPNEGO.</p>
+<p>Below are examples using the curl command tool.</p>
+<p>Authentication when security is off (Pseudo/Simple):</p>
+<div class="source">
+<pre>
+curl -i "http://<HOST>:<PORT>/<PATH>?[user.name=<USER>&]<PARAM>=..."
+
+</pre></div>
+<p>Authentication using Kerberos SPNEGO when security is on:</p>
+<div class="source">
+<pre>
+curl -i --negotiate -u : "http://<HOST>:<PORT>/<PATH>?<PARAM>=..."
+
+</pre></div>
+<p>See also: <a href="./../Security.twiki.html">Security in Falcon</a></p>
+<p>The current version of the rest api's documentation is also hosted on the Falcon server and Prism Server (in distributed mode) at the url <a class="externalLink" href="http://<HOST>:<PORT>/docs">http://<HOST>:<PORT>/docs</a></p></div>
+<div class="section">
+<h3>REST Call on Admin Resource<a name="REST_Call_on_Admin_Resource"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./AdminStack.html">api/admin/stack</a></td>
+<td>Get stack of the server</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./AdminVersion.html">api/admin/version</a></td>
+<td>Get version of the server</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./AdminConfig.html">api/admin/config/:config-type</a></td>
+<td>Get configuration information of the server</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./AdminSafemode.html">api/admin/setSafeMode/:mode</a></td>
+<td>Set safemode to true/false in falcon server</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Entity Resource<a name="REST_Call_on_Entity_Resource"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./EntityValidate.html">api/entities/validate/:entity-type</a></td>
+<td>Validate the entity</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./EntitySubmit.html">api/entities/submit/:entity-type</a></td>
+<td>Submit the entity</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./EntityUpdate.html">api/entities/update/:entity-type/:entity-name</a></td>
+<td>Update the entity</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./EntitySubmitAndSchedule.html">api/entities/submitAndSchedule/:entity-type</a></td>
+<td>Submit & Schedule the entity</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./EntitySchedule.html">api/entities/schedule/:entity-type/:entity-name</a></td>
+<td>Schedule the entity</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./EntitySuspend.html">api/entities/suspend/:entity-type/:entity-name</a></td>
+<td>Suspend the entity</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./EntityResume.html">api/entities/resume/:entity-type/:entity-name</a></td>
+<td>Resume the entity</td></tr>
+<tr class="a">
+<td>DELETE</td>
+<td><a href="./EntityDelete.html">api/entities/delete/:entity-type/:entity-name</a></td>
+<td>Delete the entity</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./EntityStatus.html">api/entities/status/:entity-type/:entity-name</a></td>
+<td>Get the status of the entity</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./EntityDefinition.html">api/entities/definition/:entity-type/:entity-name</a></td>
+<td>Get the definition of the entity</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./EntityList.html">api/entities/list/{:entity-type}</a></td>
+<td>Get the list of entities</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./EntitySummary.html">api/entities/summary/:entity-type/:cluster</a></td>
+<td>Get instance summary of all entities</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./EntityDependencies.html">api/entities/dependencies/:entity-type/:entity-name</a></td>
+<td>Get the dependencies of the entity</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./FeedSLA.html">api/entities/sla-alert/:entity-type</a></td>
+<td>Get pending feed instances which missed sla</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./FeedLookup.html">api/entities/lookup/feed/</a></td>
+<td>Get feed for given path</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Feed and Process Instances<a name="REST_Call_on_Feed_and_Process_Instances"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./InstanceRunning.html">api/instance/running/:entity-type/:entity-name</a></td>
+<td>List of running instances.</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./InstanceParams.html">api/instance/params/:entity-type/:entity-name</a></td>
+<td>List of entity instances along with their workflow params.</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./InstanceList.html">api/instance/list/:entity-type/:entity-name</a></td>
+<td>List of instances</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./InstanceStatus.html">api/instance/status/:entity-type/:entity-name</a></td>
+<td>Status of a given instance</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./InstanceKill.html">api/instance/kill/:entity-type/:entity-name</a></td>
+<td>Kill a given instance</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./InstanceSuspend.html">api/instance/suspend/:entity-type/:entity-name</a></td>
+<td>Suspend a running instance</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./InstanceResume.html">api/instance/resume/:entity-type/:entity-name</a></td>
+<td>Resume a given instance</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./InstanceRerun.html">api/instance/rerun/:entity-type/:entity-name</a></td>
+<td>Rerun a given instance</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./InstanceLogs.html">api/instance/logs/:entity-type/:entity-name</a></td>
+<td>Get logs of a given instance</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./Triage.html">api/instance/triage/:entity-type/:entity-name</a></td>
+<td>Triage an instance to see it's stuck lineage</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./InstanceSummary.html">api/instance/summary/:entity-type/:entity-name</a></td>
+<td>Return summary of instances for an entity</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./InstanceDependency.html">api/instance/dependencies/:entity-type/:entity-name</a></td>
+<td>Return dependent instances for a given instance</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Metadata Lineage Resource<a name="REST_Call_on_Metadata_Lineage_Resource"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./Graph.html">api/metadata/lineage/serialize</a></td>
+<td>dump the graph</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./AllVertices.html">api/metadata/lineage/vertices/all</a></td>
+<td>get all vertices</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./Vertices.html">api/metadata/lineage/vertices?key=:key&value=:value</a></td>
+<td>get all vertices for a key index</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./Vertex.html">api/metadata/lineage/vertices/:id</a></td>
+<td>get the vertex with the specified id</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./VertexProperties.html">api/metadata/lineage/vertices/properties/:id?relationships=:true</a></td>
+<td>get the properties of the vertex with the specified id</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./AdjacentVertices.html">api/metadata/lineage/vertices/:id/:direction</a></td>
+<td>get the adjacent vertices or edges of the vertex with the specified direction</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./AllEdges.html">api/metadata/lineage/edges/all</a></td>
+<td>get all edges</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./Edge.html">api/metadata/lineage/edges/:id</a></td>
+<td>get the edge with the specified id</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./EntityLineage.html">api/metadata/lineage/entities?pipeline=:name</a></td>
+<td>Get lineage graph for processes and feeds in the specified pipeline</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Metadata Discovery Resource<a name="REST_Call_on_Metadata_Discovery_Resource"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./MetadataList.html">api/metadata/discovery/:dimension-type/list</a></td>
+<td>list of dimensions</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./MetadataRelations.html">api/metadata/discovery/:dimension-type/:dimension-name/relations</a></td>
+<td>Return all relations of a dimension</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Extension Artifact<a name="REST_Call_on_Extension_Artifact"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./ExtensionEnumeration.html">api/extension/enumerate</a></td>
+<td>List all the extensions supported</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./ExtensionDescription.html">api/extension/describe/:extension­name</a></td>
+<td>Return the README of the specified extension</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./ExtensionDefinition.html">api/extension/definition/:extension­name</a></td>
+<td>Return a JSON document describing the extension invocation parameters</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Extension Job Management<a name="REST_Call_on_Extension_Job_Management"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./ExtensionList.html">api/extension/list/:extension­name</a></td>
+<td>List jobs generated from an extension</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./ExtensionInstances.html">api/extension/instances/:job-name</a></td>
+<td>List instances of an extension job</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./ExtensionValidate.html">api/extension/validate/:extension­name</a></td>
+<td>Validate an extension job</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./ExtensionSubmit.html">api/extension/submit/:extension­name</a></td>
+<td>Submit an extension job</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./ExtensionUpdate.html">api/extension/update/:extension­name</a></td>
+<td>Update an extension job</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./ExtensionSubmitAndSchedule.html">api/extension/submitAndSchedule/:extension­name</a></td>
+<td>Submit and schedule an extension job</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./ExtensionSchedule.html">api/extension/schedule/:job-name</a></td>
+<td>Schedule an extension job</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./ExtensionSuspend.html">api/extension/suspend/:job-name</a></td>
+<td>Suspend an extension job</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./ExtensionResume.html">api/extension/resume/:job-name</a></td>
+<td>Resume an extension job</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./ExtensionDelete.html">api/extension/delete/:job-name</a></td>
+<td>Delete an extension job</td></tr></table></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/Triage.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/Triage.html b/content/0.10/restapi/Triage.html
new file mode 100644
index 0000000..6f0b243
--- /dev/null
+++ b/content/0.10/restapi/Triage.html
@@ -0,0 +1,141 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/instance/triage/:entity-type/:entity-name</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/instance/triage/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/instance/triage/:entity-type/:entity-name<a name="GET_apiinstancetriage:entity-type:entity-name"></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>Given a feed/process instance this command traces it's ancestors to find what all ancestors have failed. It's useful if lot of instances are failing in a pipeline as it then finds out the root cause of the pipeline being stuck.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type type of entity(feed/process).</li>
+<li>:entity-name name of the feed/process.</li>
+<li>:start instance time of the entity instance.</li>
+<li>:colo <optional param> name of the colo on which you want to triage</li>
+<li>doAs <optional query param> 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>It returns a json graph</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/instance/triage/feed/my-feed?start=2015-03-02T00:00Z&colo=local&doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "vertices": ["(FEED) my-feed (2015-03-02T00:00Z) [Unavailable]", "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]", "(FEED) input-feed-for-producer (2015-03-01T00:00Z) [Available]"],
+ "edges":
+ [
+ {
+ "from" : "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]",
+ "to" : "(FEED) my-feed (2015-03-02T00:00Z) [Unavailable]",
+ "label" : "produces"
+ },
+ {
+ "from" : "(FEED) input-feed-for-producer (2015-03-01T00:00Z) [Available]",
+ "to" : "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]",
+ "label" : "consumed by"
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>
http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/Vertex.html
----------------------------------------------------------------------
diff --git a/content/0.10/restapi/Vertex.html b/content/0.10/restapi/Vertex.html
new file mode 100644
index 0000000..cb2f03c
--- /dev/null
+++ b/content/0.10/restapi/Vertex.html
@@ -0,0 +1,134 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2016-08-08
+ | 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="20160808" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/metadata/lineage/vertices/:id</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/lineage/vertices/:id</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2016-08-08</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.10</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/metadata/lineage/vertices/:id<a name="GET_apimetadatalineagevertices:id"></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>Gets the vertex with specified id.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:id is the unique id of the vertex.</li>
+<li>doAs <optional query param> 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>Vertex with the specified id.</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/lineage/vertices/4?doAs=joe
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results": [
+ {
+ "timestamp":"2014-04-21T20:55Z",
+ "name":"sampleIngestProcess",
+ "type":"process-instance",
+ "version":"2.0.0",
+ "_id":4,
+ "_type":"vertex"
+ }
+ ]
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2016
+ <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>