You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by ve...@apache.org on 2013/11/02 00:42:05 UTC
[04/13] git commit: FALCON-151 Document the REST APIs for Falcon.
Contributed by Raghav Kumar Gautam
FALCON-151 Document the REST APIs for Falcon. Contributed by Raghav Kumar Gautam
Project: http://git-wip-us.apache.org/repos/asf/incubator-falcon/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-falcon/commit/8df7a12a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-falcon/tree/8df7a12a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-falcon/diff/8df7a12a
Branch: refs/heads/FALCON-85
Commit: 8df7a12afd59d88a835f5c14deab2f11226c525f
Parents: b7a8a97
Author: srikanth.sundarrajan <sr...@inmobi.com>
Authored: Mon Oct 28 10:47:47 2013 +0530
Committer: Venkatesh Seetharam <ve...@apache.org>
Committed: Fri Nov 1 13:38:00 2013 -0700
----------------------------------------------------------------------
CHANGES.txt | 7 +-
docs/src/site/twiki/FalconDocumentation.twiki | 1 +
docs/src/site/twiki/index.twiki | 3 +-
docs/src/site/twiki/restapi/AdminConfig.twiki | 36 ++++
docs/src/site/twiki/restapi/AdminStack.twiki | 40 +++++
docs/src/site/twiki/restapi/AdminVersion.twiki | 27 +++
.../site/twiki/restapi/EntityDefinition.twiki | 53 ++++++
docs/src/site/twiki/restapi/EntityDelete.twiki | 31 ++++
.../site/twiki/restapi/EntityDependencies.twiki | 41 +++++
docs/src/site/twiki/restapi/EntityList.twiki | 37 ++++
docs/src/site/twiki/restapi/EntityResume.twiki | 30 ++++
.../src/site/twiki/restapi/EntitySchedule.twiki | 30 ++++
docs/src/site/twiki/restapi/EntityStatus.twiki | 30 ++++
docs/src/site/twiki/restapi/EntitySubmit.twiki | 106 ++++++++++++
.../twiki/restapi/EntitySubmitAndSchedule.twiki | 63 +++++++
docs/src/site/twiki/restapi/EntitySuspend.twiki | 30 ++++
docs/src/site/twiki/restapi/EntityUpdate.twiki | 65 +++++++
.../src/site/twiki/restapi/EntityValidate.twiki | 172 +++++++++++++++++++
docs/src/site/twiki/restapi/InstanceKill.twiki | 42 +++++
docs/src/site/twiki/restapi/InstanceLogs.twiki | 49 ++++++
docs/src/site/twiki/restapi/InstanceRerun.twiki | 41 +++++
.../src/site/twiki/restapi/InstanceResume.twiki | 41 +++++
.../site/twiki/restapi/InstanceRunning.twiki | 38 ++++
.../src/site/twiki/restapi/InstanceStatus.twiki | 42 +++++
.../site/twiki/restapi/InstanceSuspend.twiki | 42 +++++
docs/src/site/twiki/restapi/ResourceList.twiki | 39 +++++
26 files changed, 1133 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index 5e5e983..b18f734 100755
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -53,8 +53,11 @@ Trunk (Unreleased)
via Srikanth Sundarrajan)
IMPROVEMENTS
- FALCON-152 REST API for entity & Admin resources only returns
- XML. (Venkatesh Seetharam via Srikanth Sundarrajan)
+ FALCON-151 Document the REST APIs for Falcon. (Raghav Kumar
+ Gautham via Srikanth Sundarrajan)
+
+ FALCON-152 REST API for entity & Admin resources only returns
+ XML (Venkatesh Seetharam via Srikanth Sundarrajan)
FALCON-134 Remove jsch dependency. (Jean-Baptiste Onofre via
Srikanth Sundarrajan)
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/FalconDocumentation.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/FalconDocumentation.twiki b/docs/src/site/twiki/FalconDocumentation.twiki
index c4afaa0..71affa0 100644
--- a/docs/src/site/twiki/FalconDocumentation.twiki
+++ b/docs/src/site/twiki/FalconDocumentation.twiki
@@ -135,6 +135,7 @@ Examples:
---++ Entity Management actions
+All the following operation can also be done using [[restapi/ResourceList][Falcon's RESTful API]].
---+++ Submit
Entity submit action allows a new cluster/feed/process to be setup within Falcon. Submitted entity is not
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/index.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/index.twiki b/docs/src/site/twiki/index.twiki
index 0b486ff..81c4c3e 100644
--- a/docs/src/site/twiki/index.twiki
+++ b/docs/src/site/twiki/index.twiki
@@ -26,7 +26,8 @@ to Falcon architecture and documentation in [[FalconDocumentation][Documentation
describes steps to on-board a pipeline to Falcon. It also gives a sample pipeline for reference.
[[EntitySpecification][Entity Specification]] gives complete details of all Falcon entities.
-[[FalconCLI][Falcon CLI]] describes the various options for the command line utility provided by Falcon.
+[[FalconCLI][Falcon CLI]] implements [[restapi/ResourceList][Falcon's RESTful API]] and
+describes various options for the command line utility provided by Falcon.
Falcon provides OOTB [[HiveIntegration][lifecycle management for Tables in Hive (HCatalog)]]
such as table replication for BCP and table eviction.
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/AdminConfig.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/AdminConfig.twiki b/docs/src/site/twiki/restapi/AdminConfig.twiki
new file mode 100644
index 0000000..2841b25
--- /dev/null
+++ b/docs/src/site/twiki/restapi/AdminConfig.twiki
@@ -0,0 +1,36 @@
+---++ GET /api/admin/config/:config-type
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get configuration information of the falcon server.
+
+---++ Parameters
+ * :config-type can be build, deploy, startup or runtime
+
+---++ Results
+Configuration information of the server.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/admin/config/deploy
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "properties": [
+ {
+ "value": "embedded",
+ "key": "deploy.mode"
+ },
+ {
+ "value": "all",
+ "key": "domain"
+ }
+ ]
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/AdminStack.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/AdminStack.twiki b/docs/src/site/twiki/restapi/AdminStack.twiki
new file mode 100644
index 0000000..a241999
--- /dev/null
+++ b/docs/src/site/twiki/restapi/AdminStack.twiki
@@ -0,0 +1,40 @@
+---++ GET /api/admin/stack
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get stack trace of the falcon server.
+
+---++ Parameters
+None.
+---++ Results
+Stack trace of the server.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/admin/stack
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+Reference Handler
+State: WAITING
+java.lang.Object.wait(Native Method)
+java.lang.Object.wait(Object.java:485)
+java.lang.ref.Reference$ReferenceHandler.run(Reference.java:116)Finalizer
+
+...
+
+State: TIMED_WAITING
+sun.misc.Unsafe.park(Native Method)
+java.util.concurrent.locks.LockSupport.parkNanos(LockSupport.java:196)
+java.util.concurrent.SynchronousQueue$TransferStack.awaitFulfill(SynchronousQueue.java:424)
+java.util.concurrent.SynchronousQueue$TransferStack.transfer(SynchronousQueue.java:323)
+java.util.concurrent.SynchronousQueue.poll(SynchronousQueue.java:874)
+java.util.concurrent.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:955)
+java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:917)
+java.lang.Thread.run(Thread.java:695)
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/AdminVersion.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/AdminVersion.twiki b/docs/src/site/twiki/restapi/AdminVersion.twiki
new file mode 100644
index 0000000..48315ed
--- /dev/null
+++ b/docs/src/site/twiki/restapi/AdminVersion.twiki
@@ -0,0 +1,27 @@
+---++ GET /api/admin/version
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get version of the falcon server.
+
+---++ Parameters
+None.
+---++ Results
+Version of the server.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/admin/version
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ Version:"0.4-incubating-SNAPSHOT-rc0f2701549628f2f97746bd024518512c07d5442",
+ Mode:"embedded"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntityDefinition.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntityDefinition.twiki b/docs/src/site/twiki/restapi/EntityDefinition.twiki
new file mode 100644
index 0000000..955be71
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntityDefinition.twiki
@@ -0,0 +1,53 @@
+---++ GET /api/entities/definition/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get definition of the entity.
+
+---++ Parameters
+ * :entity-type can be cluster, feed or process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Definition of the entity.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/definition/process/SampleProcess
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<process name="SampleProcess" xmlns="uri:falcon:process:0.1">
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z"/>
+ </cluster>
+ </clusters>
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+ <timezone>UTC</timezone>
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)"/>
+ </inputs>
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)"/>
+ </outputs>
+ <properties>
+ <property name="queueName" value="default"/>
+ <property name="ssh.host" value="localhost"/>
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}"/>
+ </properties>
+ <workflow engine="oozie" path="/examples/apps/aggregator"/>
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3"/>
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput"/>
+ </late-process>
+</process>
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntityDelete.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntityDelete.twiki b/docs/src/site/twiki/restapi/EntityDelete.twiki
new file mode 100644
index 0000000..7a7e22a
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntityDelete.twiki
@@ -0,0 +1,31 @@
+---++ DELETE /api/entities/delete/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Delete the specified entity.
+
+---++ Parameters
+ * :entity-type can be feed or process.
+ * :entity-name is name of the feed or process.
+
+---++ Results
+Results of the delete operation.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+DELETE http://localhost:15000/api/entities/delete/cluster/SampleProcess
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "falcon\/17ff6ca6-1c8a-459f-9ba8-8fec480e384a\n",
+ "message": "falcon\/SampleProcess(cluster) removed successfully\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
+
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntityDependencies.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntityDependencies.twiki b/docs/src/site/twiki/restapi/EntityDependencies.twiki
new file mode 100644
index 0000000..6daab68
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntityDependencies.twiki
@@ -0,0 +1,41 @@
+---++ GET /api/entities/dependencies/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get dependencies of the entity.
+
+---++ Parameters
+ * :entity-type can be cluster, feed or process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Dependenciess of the entity.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/dependencies/process/SampleProcess
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "entity": [
+ {
+ "name": "SampleInput",
+ "type": "feed"
+ },
+ {
+ "name": "SampleOutput",
+ "type": "feed"
+ },
+ {
+ "name": "primary-cluster",
+ "type": "cluster"
+ }
+ ]
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntityList.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntityList.twiki b/docs/src/site/twiki/restapi/EntityList.twiki
new file mode 100644
index 0000000..45416ad
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntityList.twiki
@@ -0,0 +1,37 @@
+---++ GET /api/entities/list/:entity-type
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get list of the entities.
+
+---++ Parameters
+ * :entity-type can be cluster, feed or process.
+
+---++ Results
+List of the entities.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/list/feed
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "entity": [
+ {
+ "name": "SampleOutput",
+ "type": "feed"
+ },
+ {
+ "name": "SampleInput",
+ "type": "feed"
+ }
+ ]
+}
+</verbatim>
+
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntityResume.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntityResume.twiki b/docs/src/site/twiki/restapi/EntityResume.twiki
new file mode 100644
index 0000000..223a83f
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntityResume.twiki
@@ -0,0 +1,30 @@
+---++ POST /api/entities/resume/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Resume a supended entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Result of the resume command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/resume/process/SampleProcess
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/106582a9-130f-4903-8b8f-f95d7b286c30\n",
+ "message": "default\/SampleProcess(process) resumed successfully\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntitySchedule.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntitySchedule.twiki b/docs/src/site/twiki/restapi/EntitySchedule.twiki
new file mode 100644
index 0000000..e481613
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntitySchedule.twiki
@@ -0,0 +1,30 @@
+---++ POST /api/entities/schedule/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Schedule an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Result of the schedule command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/schedule/process/SampleProcess
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/ee735c95-98bd-41b8-a705-2e78bcfcdcd9\n",
+ "message": "default\/SampleProcess(process) scheduled successfully\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntityStatus.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntityStatus.twiki b/docs/src/site/twiki/restapi/EntityStatus.twiki
new file mode 100644
index 0000000..f0e772b
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntityStatus.twiki
@@ -0,0 +1,30 @@
+---++ GET /api/entities/status/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get status of the entity.
+
+---++ Parameters
+ * :entity-type can be cluster, feed or process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Status of the entity.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/entities/status/process/SampleProcess
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/4d35b382-852a-4bc7-9972-b9db3493322a\n",
+ "message": "default\/SUBMITTED\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntitySubmit.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntitySubmit.twiki b/docs/src/site/twiki/restapi/EntitySubmit.twiki
new file mode 100644
index 0000000..e4b608e
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntitySubmit.twiki
@@ -0,0 +1,106 @@
+---++ POST api/entities/submit/:entity-type
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Submit the given entity.
+
+---++ Parameters
+:entity-type can be cluster, feed or process.
+
+---++ Results
+Result of the submission.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/submit/feed
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Hourly sample input data -->
+
+<feed description="sample input data"
+ name="SampleInput" xmlns="uri:falcon:feed:0.1"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <groups>group</groups>
+ <frequency>hours(1)</frequency>
+ <late-arrival cut-off="hours(6)" />
+ <clusters>
+ <cluster name="primary-cluster" type="source">
+ <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+ <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+ <retention limit="months(24)" action="delete" />
+ </cluster>
+ </clusters>
+
+ <locations>
+ <location type="data" path="/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput" />
+ <location type="stats" path="/projects/bootcamp/stats/SampleInput" />
+ <location type="meta" path="/projects/bootcamp/meta/SampleInput" />
+ </locations>
+
+ <ACL owner="suser" group="users" permission="0755" />
+
+ <schema location="/none" provider="none" />
+</feed>
+</verbatim>
+
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/d72a41f7-6420-487b-8199-62d66e492e35\n",
+ "message": "default\/Submit successful (feed) SampleInput\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/submit/process
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+ </cluster>
+ </clusters>
+
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+ </inputs>
+
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+ </outputs>
+
+ <properties>
+ <property name="queueName" value="default" />
+ <property name="ssh.host" value="localhost" />
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+ </properties>
+
+ <workflow engine="oozie" path="/examples/apps/aggregator" />
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+ </late-process>
+</process>
+</verbatim>
+
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/e5cc8230-f356-4566-9b65-536abdff8aa3\n",
+ "message": "default\/Submit successful (process) SampleProcess\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntitySubmitAndSchedule.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntitySubmitAndSchedule.twiki b/docs/src/site/twiki/restapi/EntitySubmitAndSchedule.twiki
new file mode 100644
index 0000000..fb3649d
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntitySubmitAndSchedule.twiki
@@ -0,0 +1,63 @@
+---++ POST /api/entities/submitAndSchedule/:entity-type
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Submits and schedules an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+
+---++ Results
+Result of the submit and schedule command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/submitAndSchedule/process
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+ </cluster>
+ </clusters>
+
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+ </inputs>
+
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+ </outputs>
+
+ <properties>
+ <property name="queueName" value="default" />
+ <property name="ssh.host" value="localhost" />
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+ </properties>
+
+ <workflow engine="oozie" path="/examples/apps/aggregator" />
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+ </late-process>
+</process>
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "schedule\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\nsubmit\/default\/b5b40931-175b-4b15-8f2b-02ef2e66f06b\n\n",
+ "message": "schedule\/default\/SampleProcess(process) scheduled successfully\n\nsubmit\/default\/Submit successful (process) SampleProcess\n\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntitySuspend.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntitySuspend.twiki b/docs/src/site/twiki/restapi/EntitySuspend.twiki
new file mode 100644
index 0000000..9d6e9ab
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntitySuspend.twiki
@@ -0,0 +1,30 @@
+---++ POST /api/entities/suspend/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Suspend an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+
+---++ Results
+Status of the entity.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/suspend/process/SampleProcess
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "default\/fe5f2b6c-1f2e-49fc-af3a-342079f0b46b\n",
+ "message": "default\/SampleProcess(process) suspended successfully\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntityUpdate.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntityUpdate.twiki b/docs/src/site/twiki/restapi/EntityUpdate.twiki
new file mode 100644
index 0000000..82e9f2e
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntityUpdate.twiki
@@ -0,0 +1,65 @@
+---++ POST api/entities/update/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Updates the submitted entity.
+
+---++ Parameters
+ * :entity-type can be feed or process.
+ * :entity-name is name of the feed or process.
+
+---++ Results
+Result of the validation.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/update/process/SampleProcess
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+ </cluster>
+ </clusters>
+
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+ </inputs>
+
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+ </outputs>
+
+ <properties>
+ <property name="queueName" value="default" />
+ <property name="ssh.host" value="localhost" />
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+ </properties>
+
+ <workflow engine="oozie" path="/examples/apps/aggregator" />
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+ </late-process>
+</process>
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "update\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n",
+ "message": "update\/default\/SampleProcess updated successfully\n\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
+
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/EntityValidate.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/EntityValidate.twiki b/docs/src/site/twiki/restapi/EntityValidate.twiki
new file mode 100644
index 0000000..bc0f508
--- /dev/null
+++ b/docs/src/site/twiki/restapi/EntityValidate.twiki
@@ -0,0 +1,172 @@
+---++ POST api/entities/validate/entity-type
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Validates the submitted entity.
+
+---++ Parameters
+:entity-type can be cluster, feed or process.
+
+---++ Results
+Result of the validation.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/validate/cluster
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<cluster xmlns="uri:falcon:cluster:0.1" name="primary-cluster" description="Primary Cluster" colo="west-coast">
+ <interfaces>
+ <interface type="readonly" endpoint="hftp://localhost:50070" version="1.1.1"/>
+ <interface type="write" endpoint="hdfs://localhost:9000" version="1.1.1"/>
+ <interface type="execute" endpoint="localhost:9001" version="1.1.1"/>
+ <interface type="workflow" endpoint="http://localhost:11000/oozie/" version="3.3.0"/>
+ <interface type="messaging" endpoint="tcp://localhost:61616?daemon=true" version="5.4.3"/>
+ </interfaces>
+ <locations>
+ <location name="staging" path="/apps/falcon/staging"/>
+ <location name="temp" path="/tmp"/>
+ <location name="working" path="/apps/falcon/working"/>
+ </locations>
+</cluster>
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "dd3f6c3a-a6f1-4c50-97fb-3f9a3f698e10",
+ "message": "Validated successfully (CLUSTER) primary-cluster",
+ "status": "SUCCEEDED"
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/validate/feed
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Hourly sample input data -->
+
+<feed description="sample input data"
+ name="SampleInput" xmlns="uri:falcon:feed:0.1"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <groups>group</groups>
+ <frequency>hours(1)</frequency>
+ <late-arrival cut-off="hours(6)" />
+ <clusters>
+ <cluster name="primary-cluster" type="source">
+ <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+ <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+ <retention limit="months(24)" action="delete" />
+ </cluster>
+ </clusters>
+
+ <locations>
+ <location type="data" path="/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput" />
+ <location type="stats" path="/projects/bootcamp/stats/SampleInput" />
+ <location type="meta" path="/projects/bootcamp/meta/SampleInput" />
+ </locations>
+
+ <ACL owner="suser" group="users" permission="0755" />
+
+ <schema location="/none" provider="none" />
+</feed>
+</verbatim>
+
+---+++ Result
+<verbatim>
+{
+ "requestId": "c85b190e-e653-493a-a863-d62de9c2e3b0",
+ "message": "Validated successfully (FEED) SampleInput",
+ "status": "SUCCEEDED"
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/validate/feed
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample output data -->
+
+<feed description="sample output data" name="SampleOutput" xmlns="uri:falcon:feed:0.1"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <groups>group</groups>
+ <frequency>hours(1)</frequency>
+ <late-arrival cut-off="hours(6)" />
+ <clusters>
+ <cluster name="primary-cluster" type="source">
+ <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+ <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+ <retention limit="months(24)" action="delete" />
+ </cluster>
+ </clusters>
+ <locations>
+ <location type="data" path="/projects/bootcamp/output/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleOutput" />
+ <location type="stats" path="/projects/bootcamp/stats/SampleOutput" />
+ <location type="meta" path="/projects/bootcamp/meta/SampleOutput" />
+ </locations>
+ <ACL owner="suser" group="users" permission="0755" />
+ <schema location="/none" provider="none" />
+</feed>
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "requestId": "60781732-460e-4c6c-ba86-a75fae574b05",
+ "message": "Validated successfully (FEED) SampleOutput",
+ "status": "SUCCEEDED"
+}
+</verbatim>
+
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/entities/validate/process
+Remote-User: rgautam
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+ <clusters>
+ <cluster name="primary-cluster">
+ <validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+ </cluster>
+ </clusters>
+
+ <parallel>1</parallel>
+ <order>FIFO</order>
+ <frequency>hours(1)</frequency>
+
+ <inputs>
+ <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+ </inputs>
+
+ <outputs>
+ <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+ </outputs>
+
+ <properties>
+ <property name="queueName" value="default" />
+ <property name="ssh.host" value="localhost" />
+ <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+ </properties>
+
+ <workflow engine="oozie" path="/examples/apps/aggregator" />
+ <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+
+ <late-process policy="exp-backoff" delay="hours(1)">
+ <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+ </late-process>
+</process>
+</verbatim>
+
+---+++ Result
+<verbatim>
+{
+ "requestId": "e4a965c6-c7a2-41d9-ba08-2e77f1c43f57",
+ "message": "Validated successfully (PROCESS) SampleProcess",
+ "status": "SUCCEEDED"
+}
+</verbatim>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/InstanceKill.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/InstanceKill.twiki b/docs/src/site/twiki/restapi/InstanceKill.twiki
new file mode 100644
index 0000000..5c429f6
--- /dev/null
+++ b/docs/src/site/twiki/restapi/InstanceKill.twiki
@@ -0,0 +1,42 @@
+---++ POST /api/instance/kill/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Kill a currently running instance.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+ * start start time of the entity.
+
+---++ Results
+Result of the kill operation.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/kill/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T15:26:59-07:00",
+ "startTime": "2013-10-21T15:19:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "KILLED",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/23b3cfee-ee22-40c0-825d-39c322587d5f\n",
+ "message": "default\/KILL\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/InstanceLogs.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/InstanceLogs.twiki b/docs/src/site/twiki/restapi/InstanceLogs.twiki
new file mode 100644
index 0000000..ad8d6f5
--- /dev/null
+++ b/docs/src/site/twiki/restapi/InstanceLogs.twiki
@@ -0,0 +1,49 @@
+---++ GET /api/instance/logs/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get log of a specific instance of an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+ * start is the start time of the instace that you want to refer to
+
+---++ Results
+Log of specified instance.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "instances": [
+ {
+ "actions": [
+ {
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/pig_SUCCEEDED.log",
+ "status": "SUCCEEDED",
+ "action": "pig"
+ }
+ ],
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/oozie.log",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/3527038e-8334-4e50-8173-76c4fa430d0b\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/InstanceRerun.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/InstanceRerun.twiki b/docs/src/site/twiki/restapi/InstanceRerun.twiki
new file mode 100644
index 0000000..cf35475
--- /dev/null
+++ b/docs/src/site/twiki/restapi/InstanceRerun.twiki
@@ -0,0 +1,41 @@
+---++ POST /api/instance/rerun/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Rerun a specific instance of an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+ * start is the start time of the instance that you want to refer to
+
+---++ Results
+Results of the rerun command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "instances": [
+ {
+ "details": "",
+ "startTime": "2013-10-21T15:10:47-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\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n",
+ "message": "default\/RERUN\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/InstanceResume.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/InstanceResume.twiki b/docs/src/site/twiki/restapi/InstanceResume.twiki
new file mode 100644
index 0000000..2bdd6e1
--- /dev/null
+++ b/docs/src/site/twiki/restapi/InstanceResume.twiki
@@ -0,0 +1,41 @@
+---++ POST /api/instance/resume/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Resume a specific instance of an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+ * start is the start time of the instance that you want to refer to
+
+---++ Results
+Results of the resume command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "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"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/InstanceRunning.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/InstanceRunning.twiki b/docs/src/site/twiki/restapi/InstanceRunning.twiki
new file mode 100644
index 0000000..6b5ee66
--- /dev/null
+++ b/docs/src/site/twiki/restapi/InstanceRunning.twiki
@@ -0,0 +1,38 @@
+---++ GET /api/instance/running/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get a list of instances currently running for a given entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+
+---++ Results
+List of instances currently running.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "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"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/InstanceStatus.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/InstanceStatus.twiki b/docs/src/site/twiki/restapi/InstanceStatus.twiki
new file mode 100644
index 0000000..5f4a353
--- /dev/null
+++ b/docs/src/site/twiki/restapi/InstanceStatus.twiki
@@ -0,0 +1,42 @@
+---++ GET /api/instance/status/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Get status of a specific instance of an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+ * start is the start time of the instance that you want to refer to
+
+---++ Results
+Status of the specified instance.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "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"
+ }
+ ],
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/InstanceSuspend.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/InstanceSuspend.twiki b/docs/src/site/twiki/restapi/InstanceSuspend.twiki
new file mode 100644
index 0000000..62cf72b
--- /dev/null
+++ b/docs/src/site/twiki/restapi/InstanceSuspend.twiki
@@ -0,0 +1,42 @@
+---++ POST /api/instance/suspend/:entity-type/:entity-name
+ * <a href="#Description">Description</a>
+ * <a href="#Parameters">Parameters</a>
+ * <a href="#Results">Results</a>
+ * <a href="#Examples">Examples</a>
+
+---++ Description
+Suspend a specific instance of an entity.
+
+---++ Parameters
+ * :entity-type can either be a feed or a process.
+ * :entity-name is name of the entity.
+ * start is the start time of the instance that you want to refer to
+
+---++ Results
+Results of the suspend command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+</verbatim>
+---+++ Result
+<verbatim>
+{
+ "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"
+}
+</verbatim>
http://git-wip-us.apache.org/repos/asf/incubator-falcon/blob/8df7a12a/docs/src/site/twiki/restapi/ResourceList.twiki
----------------------------------------------------------------------
diff --git a/docs/src/site/twiki/restapi/ResourceList.twiki b/docs/src/site/twiki/restapi/ResourceList.twiki
new file mode 100644
index 0000000..f17cb1a
--- /dev/null
+++ b/docs/src/site/twiki/restapi/ResourceList.twiki
@@ -0,0 +1,39 @@
+---+ RESTful Resources
+ * <a href="#REST_Call_on_Entity_Resource">REST Call on Entity Resource</a>
+ * <a href="#REST_Call_on_Feed_and_Process_Instances">REST Call on Feed/Process Instances</a>
+ * <a href="#REST_Call_on_Admin_Resource">REST Call on Admin Resource</a>
+
+---++ REST Call on Admin Resource
+
+| *Call Type* | *Resource* | *Description* |
+| GET | [[AdminStack][api/admin/stack]] | Get stack of the server |
+| GET | [[AdminVersion][api/admin/version]] | Get version of the server |
+| GET | [[AdminConfig][api/admin/config/:config-type]] | Get configuration information of the server |
+
+---++ REST Call on Entity Resource
+
+| *Call Type* | *Resource* | *Description* |
+| POST | [[EntityValidate][api/entities/validate/:entity-type]] | Validate the entity |
+| POST | [[EntitySubmit][api/entities/submit/:entity-type]] | Submit the entity |
+| POST | [[EntityUpdate][api/entities/update/:entity-type/:entity-name]] | Update the entity |
+| POST | [[EntitySubmitAndSchedule][api/entities/submitAndSchedule/:entity-type]] | Submit & Schedule the entity |
+| POST | [[EntitySchedule][api/entities/schedule/:entity-type/:entity-name]] | Schedule the entity |
+| POST | [[EntitySuspend][api/entities/suspend/:entity-type/:entity-name]] | Suspend the entity |
+| POST | [[EntityResume][api/entities/resume/:entity-type/:entity-name]] | Resume the entity |
+| DELETE | [[EntityDelete][api/entities/delete/:entity-type/:entity-name]] | Delete the entity |
+| GET | [[EntityStatus][api/entities/status/:entity-type/:entity-name]] | Get the status of the entity |
+| GET | [[EntityDefinition][api/entities/definition/:entity-type/:entity-name]] | Get the definition of the entity |
+| GET | [[EntityList][api/entities/list/:entity-type]] | Get the list of entities |
+| GET | [[EntityDependencies][api/entities/dependencies/:entity-type/:entity-name]] | Get the dependencies of the entity |
+
+---++ REST Call on Feed and Process Instances
+
+| *Call Type* | *Resource* | *Description* |
+| GET | [[InstanceRunning][api/instance/running/:entity-type/:entity-name]] | List of running instances. |
+| GET | [[InstanceStatus][api/instance/status/:entity-type/:entity-name]]] | Status of a given instance |
+| POST | [[InstanceKill][api/instance/kill/:entity-type/:entity-name]]] | Kill a given instance |
+| POST | [[InstanceSuspend][api/instance/suspend/:entity-type/:entity-name]]] | Suspend a running instance |
+| POST | [[InstanceResume][api/instance/resume/:entity-type/:entity-name]]] | Resume a given instance |
+| POST | [[InstanceRerun][api/instance/rerun/:entity-type/:entity-name]]] | Rerun a given instance |
+| GET | [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]]] | Get logs of a given instance |
+