Falcon - GET /api/entities/definition/:entity-type/:entity-name

GET /api/entities/definition/:entity-type/:entity-name

Description
Parameters
Results
Examples
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

+            
+GET /api/entities/definition/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ GET http://localhost:15000/api/entities/definition/process/SampleProcess
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <process name="SampleProcess" xmlns="uri:falcon:process:0.1">
   <clusters>

Modified: incubator/falcon/site/docs/restapi/EntityDelete.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityDelete.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityDelete.html (original)
+++ incubator/falcon/site/docs/restapi/EntityDelete.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - DELETE /api/entities/delete/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,40 @@
                         
         
                                   
-            DELETE /api/entities/delete/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+DELETE /api/entities/delete/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ DELETE http://localhost:15000/api/entities/delete/cluster/SampleProcess
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "requestId": "falcon\/17ff6ca6-1c8a-459f-9ba8-8fec480e384a\n",
     "message": "falcon\/SampleProcess(cluster) removed successfully\n",

Modified: incubator/falcon/site/docs/restapi/EntityDependencies.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityDependencies.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityDependencies.html (original)
+++ incubator/falcon/site/docs/restapi/EntityDependencies.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - GET /api/entities/dependencies/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,40 @@
                         
         
                                   
-            GET /api/entities/dependencies/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+GET /api/entities/dependencies/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ GET http://localhost:15000/api/entities/dependencies/process/SampleProcess
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "entity": [
         {

Modified: incubator/falcon/site/docs/restapi/EntityList.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityList.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityList.html (original)
+++ incubator/falcon/site/docs/restapi/EntityList.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - GET /api/entities/list/:entity-type?fields=:fields
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,40 @@
                         
         
                                   
-            GET /api/entities/list/:entity-type?fields=:fields
Description
Parameters
Results
Examples
Description
Get list of the entities.
Parameters
:entity-type can be cluster, feed or process.
:fields (optional) additional fields that the client are interested in, separated by commas.
Currently falcon only support status as a valid field.
Results
List of the entities.
Examples
Rest Call
+            
+GET /api/entities/list/:entity-type?fields=:fields
+
+
+Description
+Parameters
+Results
+Examples
+
+Description
+Get list of the entities.
+
+Parameters
+
+
+:entity-type can be cluster, feed or process.
+:fields (optional) additional fields that the client are interested in, separated by commas.
Currently falcon only support status as a valid field.
+
+Results
+List of the entities.
+
+Examples
+
+Rest Call
+
+ GET http://localhost:15000/api/entities/list/feed
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "entity": [
         {
@@ -263,11 +295,19 @@ Remote-User: rgautam
     ]
 }
 
-
Rest Call
+
+
+Rest Call
+
+ GET http://localhost:15000/api/entities/list/feed?fields=status
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "entity": [
         {

Modified: incubator/falcon/site/docs/restapi/EntityResume.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityResume.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityResume.html (original)
+++ incubator/falcon/site/docs/restapi/EntityResume.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST /api/entities/resume/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,40 @@
                         
         
                                   
-            POST /api/entities/resume/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+POST /api/entities/resume/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ POST http://localhost:15000/api/entities/resume/process/SampleProcess
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "requestId": "default\/106582a9-130f-4903-8b8f-f95d7b286c30\n",
     "message": "default\/SampleProcess(process) resumed successfully\n",

Modified: incubator/falcon/site/docs/restapi/EntitySchedule.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySchedule.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySchedule.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySchedule.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST /api/entities/schedule/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,40 @@
                         
         
                                   
-            POST /api/entities/schedule/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+POST /api/entities/schedule/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ POST http://localhost:15000/api/entities/schedule/process/SampleProcess
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "requestId": "default\/ee735c95-98bd-41b8-a705-2e78bcfcdcd9\n",
     "message": "default\/SampleProcess(process) scheduled successfully\n",

Modified: incubator/falcon/site/docs/restapi/EntityStatus.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityStatus.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityStatus.html (original)
+++ incubator/falcon/site/docs/restapi/EntityStatus.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - GET /api/entities/status/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,40 @@
                         
         
                                   
-            GET /api/entities/status/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+GET /api/entities/status/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ GET http://localhost:15000/api/entities/status/process/SampleProcess
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "requestId": "default\/4d35b382-852a-4bc7-9972-b9db3493322a\n",
     "message": "default\/SUBMITTED\n",

Modified: incubator/falcon/site/docs/restapi/EntitySubmit.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySubmit.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySubmit.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySubmit.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST  api/entities/submit/:entity-type
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,7 +248,29 @@
                         
         
                                   
-            POST  api/entities/submit/:entity-type
Description
Parameters
Results
Examples
Description
Submit the given entity.
Parameters
:entity-type can be cluster, feed or process.
Results
Result of the submission.
Examples
Rest Call
+            
+POST  api/entities/submit/:entity-type
+
+
+Description
+Parameters
+Results
+Examples
+
+Description
+Submit the given entity.
+
+Parameters
+:entity-type can be cluster, feed or process.
+
+Results
+Result of the submission.
+
+Examples
+
+Rest Call
+
+ POST http://localhost:15000/api/entities/submit/feed
 Remote-User: rgautam
 <?xml version="1.0" encoding="UTF-8"?>
@@ -276,14 +301,22 @@ Remote-User: rgautam
     <schema location="/none" provider="none" />
 </feed>
 
-
Result
+
+
+Result
+
+ {
     "requestId": "default\/d72a41f7-6420-487b-8199-62d66e492e35\n",
     "message": "default\/Submit successful (feed) SampleInput\n",
     "status": "SUCCEEDED"
 }
 
-
Rest Call
+
+
+Rest Call
+
+ POST http://localhost:15000/api/entities/submit/process
 Remote-User: rgautam
 <?xml version="1.0" encoding="UTF-8"?>
@@ -321,7 +354,11 @@ Remote-User: rgautam
     </late-process>
 </process>
 
-
Result
+
+
+Result
+
+ {
     "requestId": "default\/e5cc8230-f356-4566-9b65-536abdff8aa3\n",
     "message": "default\/Submit successful (process) SampleProcess\n",

Modified: incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySubmitAndSchedule.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST /api/entities/submitAndSchedule/:entity-type
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,7 +248,31 @@
                         
         
                                   
-            POST /api/entities/submitAndSchedule/:entity-type
Description
Parameters
Results
Examples
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
+            
+POST /api/entities/submitAndSchedule/:entity-type
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ POST http://localhost:15000/api/entities/submitAndSchedule/process
 Remote-User: rgautam
 <?xml version="1.0" encoding="UTF-8"?>
@@ -283,7 +310,11 @@ Remote-User: rgautam
     </late-process>
 </process>
 
-
Result
+
+
+Result
+
+ {
     "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",

Modified: incubator/falcon/site/docs/restapi/EntitySuspend.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntitySuspend.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntitySuspend.html (original)
+++ incubator/falcon/site/docs/restapi/EntitySuspend.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST /api/entities/suspend/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,40 @@
                         
         
                                   
-            POST /api/entities/suspend/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+POST /api/entities/suspend/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ POST http://localhost:15000/api/entities/suspend/process/SampleProcess
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "requestId": "default\/fe5f2b6c-1f2e-49fc-af3a-342079f0b46b\n",
     "message": "default\/SampleProcess(process) suspended successfully\n",

Modified: incubator/falcon/site/docs/restapi/EntityUpdate.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityUpdate.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityUpdate.html (original)
+++ incubator/falcon/site/docs/restapi/EntityUpdate.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST  api/entities/update/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,7 +248,33 @@
                         
         
                                   
-            POST  api/entities/update/:entity-type/:entity-name
Description
Parameters
Results
Examples
Description
Updates the submitted entity.
Parameters
:entity-type can be feed or process.
:entity-name is name of the feed or process.
:effective is optional effective time
Results
Result of the validation.
Examples
Rest Call
+            
+POST  api/entities/update/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+Description
+Updates the submitted entity.
+
+Parameters
+
+
+:entity-type can be feed or process.
+:entity-name is name of the feed or process.
+:effective is optional effective time
+
+Results
+Result of the validation.
+
+Examples
+
+Rest Call
+
+ POST http://localhost:15000/api/entities/update/process/SampleProcess?effective=2014-01-01T00:00Z
 Remote-User: rgautam
 <?xml version="1.0" encoding="UTF-8"?>
@@ -283,7 +312,11 @@ Remote-User: rgautam
     </late-process>
 </process>
 
-
Result
+
+
+Result
+
+ {
     "requestId": "update\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n",
     "message": "update\/default\/SampleProcess updated successfully with effective time [(local/2014-01-01T00:00Z)]\n\n",

Modified: incubator/falcon/site/docs/restapi/EntityValidate.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/EntityValidate.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/EntityValidate.html (original)
+++ incubator/falcon/site/docs/restapi/EntityValidate.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST  api/entities/validate/entity-type
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,7 +248,29 @@
                         
         
                                   
-            POST  api/entities/validate/entity-type
Description
Parameters
Results
Examples
Description
Validates the submitted entity.
Parameters
:entity-type can be cluster, feed or process.
Results
Result of the validation.
Examples
Rest Call
+            
+POST  api/entities/validate/entity-type
+
+
+Description
+Parameters
+Results
+Examples
+
+Description
+Validates the submitted entity.
+
+Parameters
+:entity-type can be cluster, feed or process.
+
+Results
+Result of the validation.
+
+Examples
+
+Rest Call
+
+ POST http://localhost:15000/api/entities/validate/cluster
 Remote-User: rgautam
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
@@ -264,14 +289,22 @@ Remote-User: rgautam
     </locations>
 </cluster>
 
-
Result
+
+
+Result
+
+ {
     "requestId": "dd3f6c3a-a6f1-4c50-97fb-3f9a3f698e10",
     "message": "Validated successfully (CLUSTER) primary-cluster",
     "status": "SUCCEEDED"
 }
 
-
Rest Call
+
+
+Rest Call
+
+ POST http://localhost:15000/api/entities/validate/feed
 Remote-User: rgautam
 <?xml version="1.0" encoding="UTF-8"?>
@@ -302,14 +335,22 @@ Remote-User: rgautam
     <schema location="/none" provider="none" />
 </feed>
 
-
Result
+
+
+Result
+
+ {
     "requestId": "c85b190e-e653-493a-a863-d62de9c2e3b0",
     "message": "Validated successfully (FEED) SampleInput",
     "status": "SUCCEEDED"
 }
 
-
Rest Call
+
+
+Rest Call
+
+ POST http://localhost:15000/api/entities/validate/feed
 Remote-User: rgautam
 <?xml version="1.0" encoding="UTF-8"?>
@@ -336,14 +377,22 @@ xmlns:xsi="http://www.w3.org/2001/X
     <schema location="/none" provider="none" />
 </feed>
 
-
Result
+
+
+Result
+
+ {
     "requestId": "60781732-460e-4c6c-ba86-a75fae574b05",
     "message": "Validated successfully (FEED) SampleOutput",
     "status": "SUCCEEDED"
 }
 
-
Rest Call
+
+
+Rest Call
+
+ POST http://localhost:15000/api/entities/validate/process
 Remote-User: rgautam
 <?xml version="1.0" encoding="UTF-8"?>
@@ -381,7 +430,11 @@ Remote-User: rgautam
     </late-process>
 </process>
 
-
Result
+
+
+Result
+
+ {
     "requestId": "e4a965c6-c7a2-41d9-ba08-2e77f1c43f57",
     "message": "Validated successfully (PROCESS) SampleProcess",

Modified: incubator/falcon/site/docs/restapi/InstanceKill.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceKill.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceKill.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceKill.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST /api/instance/kill/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,41 @@
                         
         
                                   
-            POST /api/instance/kill/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+POST /api/instance/kill/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ POST http://localhost:15000/api/instance/kill/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "instances": [
         {

Modified: incubator/falcon/site/docs/restapi/InstanceLogs.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceLogs.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceLogs.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceLogs.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - GET /api/instance/logs/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,42 @@
                         
         
                                   
-            GET /api/instance/logs/:entity-type/:entity-name
Description
Parameters
Results
Examples
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 instance that you want to refer to
end <optional param> is the end time of the instance that you want to refer to
Results
Log of specified instance.
Examples
Rest Call
+            
+GET /api/instance/logs/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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 instance that you want to refer to
+end <optional param> is the end time of the instance that you want to refer to
+
+Results
+Log of specified instance.
+
+Examples
+
+Rest Call
+
+ GET http://localhost:15000/api/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "instances": [
         {

Modified: incubator/falcon/site/docs/restapi/InstanceRerun.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceRerun.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceRerun.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceRerun.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST /api/instance/rerun/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,41 @@
                         
         
                                   
-            POST /api/instance/rerun/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+POST /api/instance/rerun/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "instances": [
         {

Modified: incubator/falcon/site/docs/restapi/InstanceResume.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceResume.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceResume.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceResume.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - POST /api/instance/resume/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,41 @@
                         
         
                                   
-            POST /api/instance/resume/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+POST /api/instance/resume/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "instances": [
         {

Modified: incubator/falcon/site/docs/restapi/InstanceRunning.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceRunning.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceRunning.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceRunning.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - GET /api/instance/running/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,40 @@
                         
         
                                   
-            GET /api/instance/running/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
+            
+GET /api/instance/running/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+
+ GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "instances": [
         {

Modified: incubator/falcon/site/docs/restapi/InstanceStatus.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceStatus.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceStatus.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceStatus.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - GET /api/instance/status/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,42 @@
                         
         
                                   
-            GET /api/instance/status/:entity-type/:entity-name
Description
Parameters
Results
Examples
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
end <optional param> is the end time of the instance that you want to refer to
Results
Status of the specified instance.
Examples
Rest Call
+            
+GET /api/instance/status/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+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
+end <optional param> is the end time of the instance that you want to refer to
+
+Results
+Status of the specified instance.
+
+Examples
+
+Rest Call
+
+ GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
 Remote-User: rgautam
 
-
Result
+
+
+Result
+
+ {
     "instances": [
         {

Modified: incubator/falcon/site/docs/restapi/InstanceSummary.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/docs/restapi/InstanceSummary.html?rev=1608028&r1=1608027&r2=1608028&view=diff
==============================================================================
--- incubator/falcon/site/docs/restapi/InstanceSummary.html (original)
+++ incubator/falcon/site/docs/restapi/InstanceSummary.html Sat Jul  5 14:55:57 2014
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Falcon - GET /api/instance/summary/:entity-type/:entity-name
     
@@ -153,6 +153,9 @@
                   
                             Hive Integration
 
+                  
+                            Security
+
                           
       
                 
@@ -236,7 +239,7 @@
         
                 
                     
-                  
Last Published: 2014-02-06 
+                  Last Published: 2014-07-05 
             
                             
       
@@ -245,11 +248,42 @@
                         
         
                                   
-            GET /api/instance/summary/:entity-type/:entity-name
Description
Parameters
Results
Examples
Description
Get summary of instance/instances 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
end <optional param> is the end time of the instance that you want to refer to
Results
Summary of the instances over the specified time range
Examples
Rest Call
+            
+GET /api/instance/summary/:entity-type/:entity-name
+
+
+Description
+Parameters
+Results
+Examples
+
+Description
+Get summary of instance/instances 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
+end <optional param> is the end time of the instance that you want to refer to
+
+Results
+Summary of the instances over the specified time range
+
+Examples
+
+Rest Call
+
+ GET http://localhost:15000/api/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z
 Remote-User: suhas
 
-
Result
+
+
+Result
+
+ {
     "status":"SUCCEEDED",
     "message":"default/SUMMARY\n",