| <!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 - POST api/entities/update/:entity-type/:entity-name</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> |
| |
| |
| |
| <script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> |
| |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| |
| <div class="container"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> |
| </div> |
| </div> |
| <div class="pull-right"> </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li class=""> |
| <a href="../index.html" title="Falcon"> |
| Falcon</a> |
| </li> |
| <li class="divider ">/</li> |
| <li class="">POST api/entities/update/:entity-type/:entity-name</li> |
| |
| |
| |
| <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> |
| <li id="projectVersion" class="pull-right">Version: 0.11</li> |
| |
| </ul> |
| </div> |
| |
| |
| |
| <div id="bodyColumn" > |
| |
| <div class="section"> |
| <h3>POST api/entities/update/:entity-type/:entity-name<a name="POST__apientitiesupdate:entity-type:entity-name"></a></h3> |
| <p></p> |
| <ul> |
| <li><a href="#Description">Description</a></li> |
| <li><a href="#Parameters">Parameters</a></li> |
| <li><a href="#Results">Results</a></li> |
| <li><a href="#Examples">Examples</a></li></ul></div> |
| <div class="section"> |
| <h3>Description<a name="Description"></a></h3> |
| <p>Updates the submitted entity.</p></div> |
| <div class="section"> |
| <h3>Parameters<a name="Parameters"></a></h3> |
| <p></p> |
| <ul> |
| <li>:entity-type can be cluster, feed or process.</li> |
| <li>:entity-name is name of the cluster, feed or process.</li> |
| <li>skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.</li> |
| <li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> |
| <div class="section"> |
| <h3>Results<a name="Results"></a></h3> |
| <p>Result of the validation.</p></div> |
| <div class="section"> |
| <h3>Examples<a name="Examples"></a></h3></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| POST http://localhost:15000/api/entities/update/process/SampleProcess?skipDryRun=false&doAs=joe |
| <?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> |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "requestId": "update\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n", |
| "message": "update\/default\/SampleProcess updated successfully\n\n", |
| "status": "SUCCEEDED" |
| } |
| |
| </pre></div></div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container"> |
| <div class="row span12">Copyright © 2013-2018 |
| <a href="http://www.apache.org">Apache Software Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| <p id="poweredBy" class="pull-right"> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> |
| </a> |
| </p> |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
