| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 2018-03-12 |
| | Rendered using Apache Maven Fluido Skin 1.3.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20180312" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Falcon - 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-fluid"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <a href="../../index.html" id="bannerLeft"> |
| <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> |
| </a> |
| </div> |
| <div class="pull-right"> <a href="http://www.apache.org" id="bannerRight"> |
| <img src="../images/apache-feather-tm.gif" alt="Falcon" height="45px"/> |
| </a> |
| </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li class=""> |
| <a href="http://www.apache.org" class="externalLink" title="Apache"> |
| Apache</a> |
| </li> |
| <li class="divider ">/</li> |
| <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: 2018-03-12</li> |
| |
| </ul> |
| </div> |
| |
| |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span3"> |
| <div class="well sidebar-nav"> |
| |
| |
| <ul class="nav nav-list"> |
| <li class="nav-header">Falcon</li> |
| |
| <li> |
| |
| <a href="../index.html" title="About"> |
| <i class="none"></i> |
| About</a> |
| </li> |
| |
| <li> |
| |
| <a href="../slides/falcon-overview.html" title="Overview"> |
| <i class="none"></i> |
| Overview</a> |
| </li> |
| |
| <li> |
| |
| <a href="../slides/falcon-user-guide.html" title="User Guide"> |
| <i class="none"></i> |
| User Guide</a> |
| </li> |
| |
| <li> |
| |
| <a href="../GettingStarted.html" title="Getting Started"> |
| <i class="none"></i> |
| Getting Started</a> |
| </li> |
| |
| <li> |
| |
| <a href="../FalconDocumentation.html" title="Architecture"> |
| <i class="none"></i> |
| Architecture</a> |
| </li> |
| |
| <li> |
| |
| <a href="../InstallationSteps.html" title="Installation"> |
| <i class="none"></i> |
| Installation</a> |
| </li> |
| |
| <li> |
| |
| <a href="../OnBoarding.html" title="On Boarding"> |
| <i class="none"></i> |
| On Boarding</a> |
| </li> |
| |
| <li> |
| |
| <a href="../MigrationInstructions.html" title="Migrate to 0.10"> |
| <i class="none"></i> |
| Migrate to 0.10</a> |
| </li> |
| |
| <li> |
| |
| <a href="../Operability.html" title="Operability"> |
| <i class="none"></i> |
| Operability</a> |
| </li> |
| |
| <li> |
| |
| <a href="../EntitySpecification.html" title="Entity Specification"> |
| <i class="none"></i> |
| Entity Specification</a> |
| </li> |
| |
| <li> |
| |
| <a href="../falconcli/FalconCLI.html" title="Client (Falcon CLI)"> |
| <i class="none"></i> |
| Client (Falcon CLI)</a> |
| </li> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="icon-chevron-down"></i>Rest API</a> |
| <ul class="nav nav-list"> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="icon-chevron-down"></i>Entity Resource</a> |
| <ul class="nav nav-list"> |
| |
| <li> |
| |
| <a href="../restapi/EntityValidate.html" title="Validate the entity"> |
| <i class="none"></i> |
| Validate the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntitySubmit.html" title="Submit the entity"> |
| <i class="none"></i> |
| Submit the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntityUpdate.html" title="Update the entity"> |
| <i class="none"></i> |
| Update the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntitySubmitAndSchedule.html" title="Submit & Schedule the entity"> |
| <i class="none"></i> |
| Submit & Schedule the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntitySchedule.html" title="Schedule the entity"> |
| <i class="none"></i> |
| Schedule the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntitySuspend.html" title="Suspend the entity"> |
| <i class="none"></i> |
| Suspend the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntityResume.html" title="Resume the entity"> |
| <i class="none"></i> |
| Resume the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntityDelete.html" title="Delete the entity"> |
| <i class="none"></i> |
| Delete the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntityStatus.html" title="Get the status of the entity"> |
| <i class="none"></i> |
| Get the status of the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntityDefinition.html" title="Get the definition of the entity"> |
| <i class="none"></i> |
| Get the definition of the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntityList.html" title="Get the list of entities"> |
| <i class="none"></i> |
| Get the list of entities</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntitySummary.html" title="Get instance summary of all entities"> |
| <i class="none"></i> |
| Get instance summary of all entities</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntityDependencies.html" title="Get the dependencies of the entity"> |
| <i class="none"></i> |
| Get the dependencies of the entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/FeedLookup.html" title="Get feed for given path"> |
| <i class="none"></i> |
| Get feed for given path</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/FeedSLA.html" title="Get feed instances which missed SLA"> |
| <i class="none"></i> |
| Get feed instances which missed SLA</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="icon-chevron-down"></i>Feed/Process Instances</a> |
| <ul class="nav nav-list"> |
| |
| <li> |
| |
| <a href="../restapi/InstanceRunning.html" title="List of running instances."> |
| <i class="none"></i> |
| List of running instances.</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceParams.html" title="List of entity instances along with their workflow params."> |
| <i class="none"></i> |
| List of entity instances along with their workflow params.</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceList.html" title="List of instances"> |
| <i class="none"></i> |
| List of instances</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceStatus.html" title="Status of a given instance"> |
| <i class="none"></i> |
| Status of a given instance</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceKill.html" title="Kill a given instance"> |
| <i class="none"></i> |
| Kill a given instance</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceSuspend.html" title="Suspend a running instance"> |
| <i class="none"></i> |
| Suspend a running instance</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceResume.html" title="Resume a given instance"> |
| <i class="none"></i> |
| Resume a given instance</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceRerun.html" title="Rerun a given instance"> |
| <i class="none"></i> |
| Rerun a given instance</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceLogs.html" title="Get logs of a given instance"> |
| <i class="none"></i> |
| Get logs of a given instance</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceSummary.html" title="Return summary of instances for an entity"> |
| <i class="none"></i> |
| Return summary of instances for an entity</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/InstanceDependency.html" title="Return dependent instances of an instance"> |
| <i class="none"></i> |
| Return dependent instances of an instance</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/Triage.html" title="Triage a given instance"> |
| <i class="none"></i> |
| Triage a given instance</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="icon-chevron-down"></i>Admin Resource</a> |
| <ul class="nav nav-list"> |
| |
| <li> |
| |
| <a href="../restapi/AdminStack.html" title="Stack Trace"> |
| <i class="none"></i> |
| Stack Trace</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/AdminSafemode.html" title="Falcon Safemode"> |
| <i class="none"></i> |
| Falcon Safemode</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/AdminVersion.html" title="Version"> |
| <i class="none"></i> |
| Version</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/AdminConfig.html" title="Configuration"> |
| <i class="none"></i> |
| Configuration</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="icon-chevron-down"></i>Lineage Graph Resource</a> |
| <ul class="nav nav-list"> |
| |
| <li> |
| |
| <a href="../restapi/Graph.html" title="Dump graph"> |
| <i class="none"></i> |
| Dump graph</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/AllVertices.html" title="All vertices"> |
| <i class="none"></i> |
| All vertices</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/Vertices.html" title="Vertices for a key index"> |
| <i class="none"></i> |
| Vertices for a key index</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/Vertex.html" title="Vertex by id"> |
| <i class="none"></i> |
| Vertex by id</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/VertexProperties.html" title="Vertex Properties"> |
| <i class="none"></i> |
| Vertex Properties</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/AdjacentVertices.html" title="Adjacent Vertices"> |
| <i class="none"></i> |
| Adjacent Vertices</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/AllEdges.html" title="All edges"> |
| <i class="none"></i> |
| All edges</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/Edge.html" title="Edge by id"> |
| <i class="none"></i> |
| Edge by id</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/EntityLineage.html" title="Get lineage graph"> |
| <i class="none"></i> |
| Get lineage graph</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="icon-chevron-down"></i>Metadata Resource</a> |
| <ul class="nav nav-list"> |
| |
| <li> |
| |
| <a href="../restapi/MetadataList.html" title="List of dimensions"> |
| <i class="none"></i> |
| List of dimensions</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/MetadataRelations.html" title="List relations of a dimension"> |
| <i class="none"></i> |
| List relations of a dimension</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="icon-chevron-down"></i>Falcon Extensions</a> |
| <ul class="nav nav-list"> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionEnumeration.html" title="Enumerate Falcon Extensions"> |
| <i class="none"></i> |
| Enumerate Falcon Extensions</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionDescription.html" title="Describe an Extension"> |
| <i class="none"></i> |
| Describe an Extension</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionDefinition.html" title="Get JSON Extension properties"> |
| <i class="none"></i> |
| Get JSON Extension properties</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionList.html" title="List Extension jobs"> |
| <i class="none"></i> |
| List Extension jobs</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionInstances.html" title="List Instances of Extension job"> |
| <i class="none"></i> |
| List Instances of Extension job</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionValidate.html" title="Validate Extension Job"> |
| <i class="none"></i> |
| Validate Extension Job</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionSubmit.html" title="Submit Extension Job"> |
| <i class="none"></i> |
| Submit Extension Job</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionSubmitAndSchedule.html" title="Submit and schedule extension job"> |
| <i class="none"></i> |
| Submit and schedule extension job</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionUpdate.html" title="Update Extension Job"> |
| <i class="none"></i> |
| Update Extension Job</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionSchedule.html" title="Schedule Extension Job"> |
| <i class="none"></i> |
| Schedule Extension Job</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionSuspend.html" title="Suspend Extension Job"> |
| <i class="none"></i> |
| Suspend Extension Job</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionResume.html" title="Resume Extension Job"> |
| <i class="none"></i> |
| Resume Extension Job</a> |
| </li> |
| |
| <li> |
| |
| <a href="../restapi/ExtensionDelete.html" title="Delete Extension Job"> |
| <i class="none"></i> |
| Delete Extension Job</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| |
| <li> |
| |
| <a href="../HiveIntegration.html" title="Hive Integration"> |
| <i class="none"></i> |
| Hive Integration</a> |
| </li> |
| |
| <li> |
| |
| <a href="../Extensions.html" title="Server side Extensions"> |
| <i class="none"></i> |
| Server side Extensions</a> |
| </li> |
| |
| <li> |
| |
| <a href="../Security.html" title="Security"> |
| <i class="none"></i> |
| Security</a> |
| </li> |
| <li class="nav-header">Project Information</li> |
| |
| <li> |
| |
| <a href="../project-info.html" title="Summary"> |
| <i class="none"></i> |
| Summary</a> |
| </li> |
| |
| <li> |
| |
| <a href="../mail-lists.html" title="Mailing Lists"> |
| <i class="none"></i> |
| Mailing Lists</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" class="externalLink" title="IRC"> |
| <i class="none"></i> |
| IRC</a> |
| </li> |
| |
| <li> |
| |
| <a href="../team-list.html" title="Team"> |
| <i class="none"></i> |
| Team</a> |
| </li> |
| |
| <li> |
| |
| <a href="../issue-tracking.html" title="Issue Tracking"> |
| <i class="none"></i> |
| Issue Tracking</a> |
| </li> |
| |
| <li> |
| |
| <a href="../source-repository.html" title="Source Repository"> |
| <i class="none"></i> |
| Source Repository</a> |
| </li> |
| |
| <li> |
| |
| <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" class="externalLink" title="Wiki"> |
| <i class="none"></i> |
| Wiki</a> |
| </li> |
| |
| <li> |
| |
| <a href="../license.html" title="License"> |
| <i class="none"></i> |
| License</a> |
| </li> |
| |
| <li> |
| |
| <a href="https://cwiki.apache.org/confluence/display/FALCON/News" class="externalLink" title="News"> |
| <i class="none"></i> |
| News</a> |
| </li> |
| |
| <li> |
| |
| <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" class="externalLink" title="Powered by"> |
| <i class="none"></i> |
| Powered by</a> |
| </li> |
| |
| <li> |
| |
| <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" class="externalLink" title="Acknowledgements"> |
| <i class="none"></i> |
| Acknowledgements</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://blogs.apache.org/falcon/" class="externalLink" title="Blog"> |
| <i class="none"></i> |
| Blog</a> |
| </li> |
| <li class="nav-header">Releases</li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/dyn/closer.lua/falcon/0.11" class="externalLink" title="0.11"> |
| <i class="none"></i> |
| 0.11</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/dyn/closer.lua/falcon/0.10" class="externalLink" title="0.10"> |
| <i class="none"></i> |
| 0.10</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/dyn/closer.lua/falcon/0.9" class="externalLink" title="0.9"> |
| <i class="none"></i> |
| 0.9</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/dyn/closer.lua/falcon/0.8" class="externalLink" title="0.8"> |
| <i class="none"></i> |
| 0.8</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/dyn/closer.lua/falcon/0.7" class="externalLink" title="0.7"> |
| <i class="none"></i> |
| 0.7</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://archive.apache.org/dist/falcon/0.6.1" class="externalLink" title="0.6.1"> |
| <i class="none"></i> |
| 0.6.1</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://archive.apache.org/dist/incubator/falcon/0.6-incubating" class="externalLink" title="0.6-incubating"> |
| <i class="none"></i> |
| 0.6-incubating</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://archive.apache.org/dist/incubator/falcon/0.5-incubating" class="externalLink" title="0.5-incubating"> |
| <i class="none"></i> |
| 0.5-incubating</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://archive.apache.org/dist/incubator/falcon/0.4-incubating" class="externalLink" title="0.4-incubating"> |
| <i class="none"></i> |
| 0.4-incubating</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://archive.apache.org/dist/incubator/falcon/0.3-incubating" class="externalLink" title="0.3-incubating"> |
| <i class="none"></i> |
| 0.3-incubating</a> |
| </li> |
| |
| <li> |
| |
| <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" class="externalLink" title="Coming soon"> |
| <i class="none"></i> |
| Coming soon</a> |
| </li> |
| <li class="nav-header">Documentation</li> |
| |
| <li> |
| |
| <a href="../0.11/index.html" title="0.11 (Current)"> |
| <i class="none"></i> |
| 0.11 (Current)</a> |
| </li> |
| |
| <li> |
| |
| <a href="../0.10/index.html" title="0.10"> |
| <i class="none"></i> |
| 0.10</a> |
| </li> |
| |
| <li> |
| |
| <a href="../0.9/index.html" title="0.9"> |
| <i class="none"></i> |
| 0.9</a> |
| </li> |
| |
| <li> |
| |
| <a href="../0.8/index.html" title="0.8"> |
| <i class="none"></i> |
| 0.8</a> |
| </li> |
| |
| <li> |
| |
| <a href="../0.7/index.html" title="0.7"> |
| <i class="none"></i> |
| 0.7</a> |
| </li> |
| |
| <li> |
| |
| <a href="../0.6.1/index.html" title="0.6.1"> |
| <i class="none"></i> |
| 0.6.1</a> |
| </li> |
| |
| <li> |
| |
| <a href="../0.6-incubating/index.html" title="0.6-incubating"> |
| <i class="none"></i> |
| 0.6-incubating</a> |
| </li> |
| |
| <li> |
| |
| <a href="../0.5-incubating/index.html" title="0.5-incubating"> |
| <i class="none"></i> |
| 0.5-incubating</a> |
| </li> |
| |
| <li> |
| |
| <a href="../0.4-incubating/index.html" title="0.4-incubating"> |
| <i class="none"></i> |
| 0.4-incubating</a> |
| </li> |
| |
| <li> |
| |
| <a href="../0.3-incubating/index.html" title="0.3-incubating"> |
| <i class="none"></i> |
| 0.3-incubating</a> |
| </li> |
| <li class="nav-header">ASF</li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"> |
| <i class="none"></i> |
| How Apache Works</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation"> |
| <i class="none"></i> |
| Foundation</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"> |
| <i class="none"></i> |
| Sponsoring Apache</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"> |
| <i class="none"></i> |
| Thanks</a> |
| </li> |
| </ul> |
| |
| |
| |
| <hr class="divider" /> |
| |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <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> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="bodyColumn" class="span9" > |
| |
| <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> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container-fluid"> |
| <div class="row span12">Copyright © 2013-2018 |
| <a href="http://www.apache.org">Apache Software Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
