Added: zeppelin/site/docs/0.8.2/usage/rest_api/notebook.html
URL:
http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.2/usage/rest_api/notebook.html?rev=1867691&view=auto
==============================================================================
--- zeppelin/site/docs/0.8.2/usage/rest_api/notebook.html (added)
+++ zeppelin/site/docs/0.8.2/usage/rest_api/notebook.html Sun Sep 29 07:08:10
2019
@@ -0,0 +1,1658 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.8.0 Documentation: Apache Zeppelin Notebook REST
API</title>
+ <meta name="description" content="This page contains Apache Zeppelin
Notebook REST API information.">
+ <meta name="author" content="The Apache Software Foundation">
+
+ <!-- Enable responsive viewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js";></script>
+ <![endif]-->
+
+ <link
href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css"
rel="stylesheet">
+
+ <!-- Le styles -->
+ <link href="/docs/0.8.0/assets/themes//bootstrap/css/bootstrap.css"
rel="stylesheet">
+ <link href="/docs/0.8.0/assets/themes//css/style.css?body=1"
rel="stylesheet" type="text/css">
+ <link href="/docs/0.8.0/assets/themes//css/syntax.css" rel="stylesheet"
type="text/css" media="screen" />
+ <!-- Le fav and touch icons -->
+ <!-- Update these with your own images
+ <link rel="shortcut icon" href="images/favicon.ico">
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72"
href="images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114"
href="images/apple-touch-icon-114x114.png">
+ -->
+
+ <!-- Js -->
+ <script src="https://code.jquery.com/jquery-1.10.2.min.js";></script>
+ <script
src="/docs/0.8.0/assets/themes//bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/docs.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/anchor.min.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/toc.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/lunr.min.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.8.0/atom.xml" type="application/atom+xml"
rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.8.0/rss.xml" type="application/rss+xml"
rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div id="menu" class="navbar navbar-inverse navbar-fixed-top"
role="navigation">
+ <div class="container navbar-container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse"
data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <div class="navbar-brand">
+ <a class="navbar-brand-main" href="http://zeppelin.apache.org";>
+ <img
src="/docs/0.8.0/assets/themes/zeppelin/img/zeppelin_logo.png" width="50"
+ style="margin-top: -2px;" alt="I'm zeppelin">
+ <span style="margin-left: 5px; font-size: 27px;">Zeppelin</span>
+ <a class="navbar-brand-version" href="/docs/0.8.0"
+ style="font-size: 15px; color: white;"> 0.8.0
+ </a>
+ </a>
+ </div>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick
Start <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span>Getting Started</span></li>
+ <li><a
href="/docs/0.8.0/quickstart/install.html">Install</a></li>
+ <li><a href="/docs/0.8.0/quickstart/explore_ui.html">Explore
UI</a></li>
+ <li><a
href="/docs/0.8.0/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a
href="/docs/0.8.0/quickstart/spark_with_zeppelin.html">Spark with
Zeppelin</a></li>
+ <li><a
href="/docs/0.8.0/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li>
+ <li><a
href="/docs/0.8.0/quickstart/python_with_zeppelin.html">Python with
Zeppelin</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown"
class="dropdown-toggle">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Dynamic Form</span></li>
+ <li><a href="/docs/0.8.0/usage/dynamic_form/intro.html">What
is Dynamic Form?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Display System</span></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/basic.html#text">Text Display</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/basic.html#html">HTML Display</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/basic.html#table">Table Display</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/basic.html#network">Network
Display</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/angular_backend.html">Angular Display
using Backend API</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/angular_frontend.html">Angular Display
using Frontend API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Interpreter</span></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/overview.html">Overview</a></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/interpreter_binding_mode.html">Interpreter
Binding Mode</a></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/user_impersonation.html">User
Impersonation</a></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/dependency_management.html">Dependency
Management</a></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/installation.html">Installing
Interpreters</a></li>
+ <!--<li><a
href="/docs/0.8.0/usage/interpreter/dynamic_loading.html">Dynamic Interpreter
Loading (Experimental)</a></li>-->
+ <li><a
href="/docs/0.8.0/usage/interpreter/execution_hooks.html">Execution Hooks
(Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Other Features</span></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/publishing_paragraphs.html">Publishing
Paragraphs</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/personalized_mode.html">Personalized
Mode</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/customizing_homepage.html">Customizing
Zeppelin Homepage</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/notebook_actions.html">Notebook
Actions</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/cron_scheduler.html">Cron
Scheduler</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/zeppelin_context.html">Zeppelin
Context</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>REST API</span></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/interpreter.html">Interpreter API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/zeppelin_server.html">Zeppelin Server
API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/notebook.html">Notebook API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/notebook_repository.html">Notebook Repository
API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/configuration.html">Configuration API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/credential.html">Credential API</a></li>
+ <li><a href="/docs/0.8.0/usage/rest_api/helium.html">Helium
API</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown"
class="dropdown-toggle">Setup<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Basics</span></li>
+ <li><a href="/docs/0.8.0/setup/basics/how_to_build.html">How
to Build Zeppelin</a></li>
+ <li><a
href="/docs/0.8.0/setup/basics/multi_user_support.html">Multi-user
Support</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Deployment</span></li>
+ <!--<li><a
href="/docs/0.8.0/setup/deployment/docker.html">Docker Image for
Zeppelin</a></li>-->
+ <li><a
href="/docs/0.8.0/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark
Cluster Mode: Standalone</a></li>
+ <li><a
href="/docs/0.8.0/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark
Cluster Mode: YARN</a></li>
+ <li><a
href="/docs/0.8.0/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark
Cluster Mode: Mesos</a></li>
+ <li><a
href="/docs/0.8.0/setup/deployment/flink_and_spark_cluster.html">Zeppelin with
Flink, Spark Cluster</a></li>
+ <li><a href="/docs/0.8.0/setup/deployment/cdh.html">Zeppelin
on CDH</a></li>
+ <li><a
href="/docs/0.8.0/setup/deployment/virtual_machine.html">Zeppelin on VM:
Vagrant</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Security</span></li>
+ <li><a
href="/docs/0.8.0/setup/security/authentication_nginx.html">HTTP Basic Auth
using NGINX</a></li>
+ <li><a
href="/docs/0.8.0/setup/security/shiro_authentication.html">Shiro
Authentication</a></li>
+ <li><a
href="/docs/0.8.0/setup/security/notebook_authorization.html">Notebook
Authorization</a></li>
+ <li><a
href="/docs/0.8.0/setup/security/datasource_authorization.html">Data Source
Authorization</a></li>
+ <li><a
href="/docs/0.8.0/setup/security/http_security_headers.html">HTTP Security
Headers</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Notebook Storage</span></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git
Storage</a></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-s3">S3
Storage</a></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-azure">Azure
Storage</a></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-zeppelinhub">ZeppelinHub
Storage</a></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-mongodb">MongoDB
Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Operation</span></li>
+ <li><a
href="/docs/0.8.0/setup/operation/configuration.html">Configuration</a></li>
+ <li><a
href="/docs/0.8.0/setup/operation/proxy_setting.html">Proxy Setting</a></li>
+ <li><a
href="/docs/0.8.0/setup/operation/upgrading.html">Upgrading</a></li>
+ <li><a
href="/docs/0.8.0/setup/operation/trouble_shooting.html">Trouble
Shooting</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown"
class="dropdown-toggle">Interpreter <b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Interpreters</span></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/overview.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.8.0/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.8.0/interpreter/jdbc.html">JDBC</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/python.html">Python</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a
href="/docs/0.8.0/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.8.0/interpreter/beam.html">Beam</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.8.0/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.8.0/interpreter/geode.html">Geode</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/groovy.html">Groovy</a></li>
+ <li><a href="/docs/0.8.0/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.8.0/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.8.0/interpreter/hive.html">Hive</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.8.0/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.8.0/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.8.0/interpreter/livy.html">Livy</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.8.0/interpreter/neo4j.html">Neo4j</a></li>
+ <li><a href="/docs/0.8.0/interpreter/pig.html">Pig</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.8.0/interpreter/r.html">R</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.8.0/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.8.0/interpreter/shell.html">Shell</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown"
class="dropdown-toggle">More<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu" style="right: 0; left:
auto;">
+ <li class="title"><span>Extending Zeppelin</span></li>
+ <li><a
href="/docs/0.8.0/development/writing_zeppelin_interpreter.html">Writing
Zeppelin Interpreter</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Helium (Experimental)</span></li>
+ <li><a
href="/docs/0.8.0/development/helium/overview.html">Overview</a></li>
+ <li><a
href="/docs/0.8.0/development/helium/writing_application.html">Writing Helium
Application</a></li>
+ <li><a
href="/docs/0.8.0/development/helium/writing_spell.html">Writing Helium
Spell</a></li>
+ <li><a
href="/docs/0.8.0/development/helium/writing_visualization_basic.html">Writing
Helium Visualization: Basics</a></li>
+ <li><a
href="/docs/0.8.0/development/helium/writing_visualization_transformation.html">Writing
Helium Visualization: Transformation</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Contributing to Zeppelin</span></li>
+ <li><a href="/docs/0.8.0/setup/basics/how_to_build.html">How
to Build Zeppelin</a></li>
+ <li><a
href="/docs/0.8.0/development/contribution/useful_developer_tools.html">Useful
Developer Tools</a></li>
+ <li><a
href="/docs/0.8.0/development/contribution/how_to_contribute_code.html">How to
Contribute (code)</a></li>
+ <li><a
href="/docs/0.8.0/development/contribution/how_to_contribute_website.html">How
to Contribute (website)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>External Resources</span></li>
+ <li><a target="_blank" href="">Mailing List</a></li>
+ <li><a target="_blank" href="">Apache Zeppelin Wiki</a></li>
+ <li><a target="_blank" href="">Stackoverflow Questions about
Zeppelin</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.8.0/search.html" class="nav-search-link">
+ <span class="fa fa-search nav-search-icon"></span>
+ </a>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+
+ <div class="content">
+
+<!--<div class="hero-unit Apache Zeppelin Notebook REST API">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<h1>Apache Zeppelin Notebook REST API</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<p>Apache Zeppelin provides several REST APIs for interaction and remote
activation of zeppelin functionality.
+All REST APIs are available starting with the following endpoint
<code>http://[zeppelin-server]:[zeppelin-port]/api</code>.
+Note that Apache Zeppelin REST APIs receive or return JSON objects, it is
recommended for you to install some JSON viewers such as <a
href="https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc";>JSONView</a>.
+If you work with Apache Zeppelin and find a need for an additional REST API,
please <a href="http://zeppelin.apache.org/community.html";>file an issue or
send us an email</a>.</p>
+
+<p>Notebooks REST API supports the following operations: List, Create, Get,
Delete, Clone, Run, Export, Import as detailed in the following tables.</p>
+
+<h2>Note operations</h2>
+
+<h3>List of the notes</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method lists the available notes on your
server.
+ Notebook JSON contains the <code>name</code> and <code>id</code> of
all notes.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": [
+ {
+ "name":"Homepage",
+ "id":"2AV4WUEMK"
+ },
+ {
+ "name":"Zeppelin Tutorial",
+ "id":"2A94M5J1Z"
+ }
+ ]
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Create a new note</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method creates a new note using the given
name or default name if none given.
+ The body field of the returned JSON contains the new note id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON input (without paragraphs) </td>
+ <td><pre>{"name": "name of new note"}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON input (with initial paragraphs) </td>
+ <td><pre>
+{
+ "name": "name of new note",
+ "paragraphs": [
+ {
+ "title": "paragraph title1",
+ "text": "paragraph text1"
+ },
+ {
+ "title": "paragraph title2",
+ "text": "paragraph text2",
+ "config": {
+ "title": true,
+ "colWidth": 6.0,
+ "results": [
+ {
+ "graph": {
+ "mode": "scatterChart",
+ "optionOpen": true
+ }
+ }
+ ]
+ }
+ }
+ ]
+}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": "2AZPHY918"
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Get the status of all paragraphs</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method gets the status of all paragraphs by
the given note id.
+ The body field of the returned JSON contains of the array that
compose of the paragraph id, paragraph status, paragraph finish date, paragraph
started date.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "body": [
+ {
+ "id":"20151121-212654_766735423",
+ "status":"FINISHED",
+ "finished":"Tue Nov 24 14:21:40 KST 2015",
+ "started":"Tue Nov 24 14:21:39 KST 2015"
+ },
+ {
+ "progress":"1",
+ "id":"20151121-212657_730976687",
+ "status":"RUNNING",
+ "finished":"Tue Nov 24 14:21:35 KST 2015",
+ "started":"Tue Nov 24 14:21:40 KST 2015"
+ }
+ ]
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Get an existing note information</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method retrieves an existing note's
information using the given id.
+ The body field of the returned JSON contain information about
paragraphs in the note.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "paragraphs": [
+ {
+ "text": "%sql \nselect age, count(1) value\nfrom bank
\nwhere age < 30 \ngroup by age \norder by age",
+ "config": {
+ "colWidth": 4,
+ "graph": {
+ "mode": "multiBarChart",
+ "height": 300,
+ "optionOpen": false,
+ "keys": [
+ {
+ "name": "age",
+ "index": 0,
+ "aggr": "sum"
+ }
+ ],
+ "values": [
+ {
+ "name": "value",
+ "index": 1,
+ "aggr": "sum"
+ }
+ ],
+ "groups": [],
+ "scatter": {
+ "xAxis": {
+ "name": "age",
+ "index": 0,
+ "aggr": "sum"
+ },
+ "yAxis": {
+ "name": "value",
+ "index": 1,
+ "aggr": "sum"
+ }
+ }
+ }
+ },
+ "settings": {
+ "params": {},
+ "forms": {}
+ },
+ "jobName": "paragraph_1423500782552_-1439281894",
+ "id": "20150210-015302_1492795503",
+ "results": {
+ "code": "SUCCESS",
+ "msg": [
+ {
+ "type": "TABLE",
+ "data":
"age\tvalue\n19\t4\n20\t3\n21\t7\n22\t9\n23\t20\n24\t24\n25\t44\n26\t77\n27\t94\n28\t103\n29\t97\n"
+ }
+ ]
+ },
+ "dateCreated": "Feb 10, 2015 1:53:02 AM",
+ "dateStarted": "Jul 3, 2015 1:43:17 PM",
+ "dateFinished": "Jul 3, 2015 1:43:23 PM",
+ "status": "FINISHED",
+ "progressUpdateIntervalMs": 500
+ }
+ ],
+ "name": "Zeppelin Tutorial",
+ "id": "2A94M5J1Z",
+ "angularObjects": {},
+ "config": {
+ "looknfeel": "default"
+ },
+ "info": {}
+ }
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Delete a note</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method deletes a note by the given note id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK","message":
""}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Clone a note</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method clones a note by the given id and
create a new note using the given name
+ or default name if none given.
+ The body field of the returned JSON contains the new note id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON input </td>
+ <td><pre>{"name": "name of new note"}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": "2AZPHY918"
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br /></p>
+
+<h3>Export a note</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method exports a note by the given id and
gernerates a JSON
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/export/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>201</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <td> sample JSON response </td>
+ <td><pre>{
+ "paragraphs": [
+ {
+ "text": "%md This is my new paragraph in my new
note",
+ "dateUpdated": "Jan 8, 2016 4:49:38 PM",
+ "config": {
+ "enabled": true
+ },
+ "settings": {
+ "params": {},
+ "forms": {}
+ },
+ "jobName": "paragraph_1452300578795_1196072540",
+ "id": "20160108-164938_1685162144",
+ "dateCreated": "Jan 8, 2016 4:49:38 PM",
+ "status": "READY",
+ "progressUpdateIntervalMs": 500
+ }
+ ],
+ "name": "source note for export",
+ "id": "2B82H3RR1",
+ "angularObjects": {},
+ "config": {},
+ "info": {}
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br /></p>
+
+<h3>Import a note</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method imports a note from the note JSON input
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/import</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>201</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td>sample JSON input</td>
+ <td><pre>
+{
+ "paragraphs": [
+ {
+ "text": "%md This is my new paragraph in my new
note",
+ "dateUpdated": "Jan 8, 2016 4:49:38 PM",
+ "config": {
+ "enabled": true
+ },
+ "settings": {
+ "params": {},
+ "forms": {}
+ },
+ "jobName": "paragraph_1452300578795_1196072540",
+ "id": "20160108-164938_1685162144",
+ "dateCreated": "Jan 8, 2016 4:49:38 PM",
+ "status": "READY",
+ "progressUpdateIntervalMs": 500
+ }
+ ],
+ "name": "source note for export",
+ "id": "2B82H3RR1",
+ "angularObjects": {},
+ "config": {},
+ "info": {}
+}</pre></td>
+ </tr>
+ <tr>
+ <td>sample JSON response</td>
+ <td><pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": "2AZPHY918"
+}</pre></td>
+ </tr>
+ </table></p>
+
+<h3>Run all paragraphs</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>
+ This <code>POST</code> method runs all paragraphs in the given note id.
<br />
+ If you can not find Note id 404 returns.
+ If there is a problem with the interpreter returns a 412 error.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 404 or 412</td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK"}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON error response </td>
+ <td>
+ <pre>
+ {
+ "status": "NOT<em>FOUND",
+ "message": "note not found."
+ }
+ </pre><br />
+ <pre>
+ {
+ "status": "PRECONDITION</em>FAILED",
+ "message":
"paragraph<em>1469771130099</em>-278315611 Not selected or Invalid
Interpreter bind"
+ }
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Stop all paragraphs</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method stops all paragraphs in the given
note id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status":"OK"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br /></p>
+
+<h3>Clear all paragraph result</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method clear all paragraph results from note
of given id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/clear</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Forbidden code</td>
+ <td>401</td>
+ </tr>
+ <tr>
+ <td>Not Found code</td>
+ <td>404</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td>sample JSON response</td>
+ <td><pre>{"status": "OK"}</pre></td>
+ </tr>
+ </tr>
+ </table></p>
+
+<h2>Paragraph operations</h2>
+
+<p><br/></p>
+
+<h3>Create a new paragraph</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method create a new paragraph using JSON
payload.
+ The body field of the returned JSON contain the new paragraph id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>201</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON input (add to the last) </td>
+ <td><pre>
+{
+ "title": "Paragraph insert revised",
+ "text": "%spark\nprintln(\"Paragraph insert
revised\")"
+}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON input (add to specific index) </td>
+ <td><pre>
+{
+ "title": "Paragraph insert revised",
+ "text": "%spark\nprintln(\"Paragraph insert
revised\")",
+ "index": 0
+}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON input (providing paragraph config) </td>
+ <td><pre>
+{
+ "title": "paragraph title2",
+ "text": "paragraph text2",
+ "config": {
+ "title": true,
+ "colWidth": 6.0,
+ "results": [
+ {
+ "graph": {
+ "mode": "pieChart",
+ "optionOpen": true
+ }
+ }
+ ]
+ }
+}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": "20151218-100330_1754029574"
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Get a paragraph information</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method retrieves an existing paragraph's
information using the given id.
+ The body field of the returned JSON contain information about
paragraph.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "title": "Paragraph2",
+ "text": "%spark\n\nprintln(\"it's
paragraph2\")",
+ "dateUpdated": "Dec 18, 2015 7:33:54 AM",
+ "config": {
+ "colWidth": 12,
+ "graph": {
+ "mode": "table",
+ "height": 300,
+ "optionOpen": false,
+ "keys": [],
+ "values": [],
+ "groups": [],
+ "scatter": {}
+ },
+ "enabled": true,
+ "title": true,
+ "editorMode": "ace/mode/scala"
+ },
+ "settings": {
+ "params": {},
+ "forms": {}
+ },
+ "jobName": "paragraph_1450391574392_-1890856722",
+ "id": "20151218-073254_1105602047",
+ "results": {
+ "code": "SUCCESS",
+ "msg": [
+ {
+ "type": "TEXT",
+ "data": "it's paragraph2\n"
+ }
+ ]
+ },
+ "dateCreated": "Dec 18, 2015 7:32:54 AM",
+ "dateStarted": "Dec 18, 2015 7:33:55 AM",
+ "dateFinished": "Dec 18, 2015 7:33:55 AM",
+ "status": "FINISHED",
+ "progressUpdateIntervalMs": 500
+ }
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Get the status of a single paragraph</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method gets the status of a single paragraph
by the given note and paragraph id.
+ The body field of the returned JSON contains of the array that
compose of the paragraph id, paragraph status, paragraph finish date, paragraph
started date.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]/[paragraphId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "body": {
+ "id":"20151121-212654_766735423",
+ "status":"FINISHED",
+ "finished":"Tue Nov 24 14:21:40 KST 2015",
+ "started":"Tue Nov 24 14:21:39 KST 2015"
+ }
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Update paragraph</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method update paragraph contents using given
id, e.g. <code>{"text": "hello"}</code>
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Bad Request code</td>
+ <td>400</td>
+ </tr>
+ <tr>
+ <td>Forbidden code</td>
+ <td>403</td>
+ </tr>
+ <tr>
+ <td>Not Found code</td>
+ <td>404</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td>sample JSON input</td>
+ <td><pre>
+{
+ "title": "Hello world",
+ "text": "println(\"hello world\")"
+}</pre></td>
+ </tr>
+ <tr>
+ <td>sample JSON response</td>
+ <td><pre>
+{
+ "status": "OK",
+ "message": ""
+ }
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Update paragraph configuration</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method update paragraph configuration using
given id so that user can change paragraph setting such as graph type, show or
hide editor/result and paragraph size, etc. You can update certain fields you
want, for example you can update <code>colWidth</code> field only by sending
request with payload <code>{"colWidth": 12.0}</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]/config</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Bad Request code</td>
+ <td>400</td>
+ </tr>
+ <tr>
+ <td>Forbidden code</td>
+ <td>403</td>
+ </tr>
+ <tr>
+ <td>Not Found code</td>
+ <td>404</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td>sample JSON input</td>
+ <td><pre>
+{
+ "colWidth": 6.0,
+ "graph": {
+ "mode": "lineChart",
+ "height": 200.0,
+ "optionOpen": false,
+ "keys": [
+ {
+ "name": "age",
+ "index": 0.0,
+ "aggr": "sum"
+ }
+ ],
+ "values": [
+ {
+ "name": "value",
+ "index": 1.0,
+ "aggr": "sum"
+ }
+ ],
+ "groups": [],
+ "scatter": {}
+ },
+ "editorHide": true,
+ "editorMode": "ace/mode/markdown",
+ "tableHide": false
+}</pre></td>
+ </tr>
+ <tr>
+ <td>sample JSON response</td>
+ <td><pre>
+{
+ "status":"OK",
+ "message":"",
+ "body":{
+ "text":"%sql \nselect age, count(1) value\nfrom bank
\nwhere age \u003c 30 \ngroup by age \norder by age",
+ "config":{
+ "colWidth":6.0,
+ "graph":{
+ "mode":"lineChart",
+ "height":200.0,
+ "optionOpen":false,
+ "keys":[
+ {
+ "name":"age",
+ "index":0.0,
+ "aggr":"sum"
+ }
+ ],
+ "values":[
+ {
+ "name":"value",
+ "index":1.0,
+ "aggr":"sum"
+ }
+ ],
+ "groups":[],
+ "scatter":{}
+ },
+ "tableHide":false,
+ "editorMode":"ace/mode/markdown",
+ "editorHide":true
+ },
+ "settings":{
+ "params":{},
+ "forms":{}
+ },
+ "apps":[],
+ "jobName":"paragraph<em>1423500782552</em>-1439281894",
+ "id":"20150210-015302_1492795503",
+ "results":{
+ "code":"SUCCESS",
+ "msg": [
+ {
+ "type":"TABLE",
+
"data":"age\tvalue\n19\t4\n20\t3\n21\t7\n22\t9\n23\t20\n24\t24\n25\t44\n26\t77\n27\t94\n28\t103\n29\t97\n"
+ }
+ ]
+ },
+ "dateCreated":"Feb 10, 2015 1:53:02 AM",
+ "dateStarted":"Jul 3, 2015 1:43:17 PM",
+ "dateFinished":"Jul 3, 2015 1:43:23 PM",
+ "status":"FINISHED",
+ "progressUpdateIntervalMs":500
+ }
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Delete a paragraph</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method deletes a paragraph by the given
note and paragraph id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK","message":
""}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Run a paragraph asynchronously</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method runs the paragraph asynchronously by
given note and paragraph id. This API always return SUCCESS even if the
execution of the paragraph fails later because the API is asynchronous
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]/[paragraphId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON input (optional, only needed when if you want to update
dynamic form's value) </td>
+ <td><pre>
+{
+ "name": "name of new note",
+ "params": {
+ "formLabel1": "value1",
+ "formLabel2": "value2"
+ }
+}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Run a paragraph synchronously</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method runs the paragraph synchronously by
given note and paragraph id. This API can return SUCCESS or ERROR depending on
the outcome of the paragraph execution
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/run/[noteId]/[paragraphId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON input (optional, only needed when if you want to update
dynamic form's value) </td>
+ <td><pre>
+{
+ "name": "name of new note",
+ "params": {
+ "formLabel1": "value1",
+ "formLabel2": "value2"
+ }
+}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK"}</pre></td>
+ </tr><br>
+ <tr>
+ <td> sample JSON error </td>
+ <td><pre>
+{
+ "status": "INTERNAL_SERVER_ERROR",
+ "body": {
+ "code": "ERROR",
+ "type": "TEXT",
+ "msg": "bash: -c: line 0: unexpected EOF while looking
for matching ``'\nbash: -c: line 1: syntax error: unexpected end of
file\nExitValue: 2"
+ }
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Stop a paragraph</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method stops the paragraph by given note
and paragraph id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]/[paragraphId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Move a paragraph to the specific index</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method moves a paragraph to the specific
index (order) from the note.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]/move/[newIndex]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK","message":
""}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br /></p>
+
+<h3>Full text search through the paragraphs in all notes</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td><code>GET</code> request will return list of matching paragraphs
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/search?q=[query]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td>Sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "body": [
+ {
+ "id": "<noteId>/paragraph/<paragraphId>",
+ "name":"Note Name",
+ "snippet":"",
+ "text":""
+ }
+ ]
+}</pre></td>
+ </tr>
+ </table></p>
+
+<h2>Cron jobs</h2>
+
+<p><br/></p>
+
+<h3>Add Cron Job</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method adds cron job by the given note id.
+ Default value of <code>releaseResource</code> is <code>false</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON input </td>
+ <td><pre>{"cron": "cron expression of note",
"releaseResource": "false"}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Remove Cron Job</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method removes cron job by the given note
id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Get Cron Job</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method gets cron job expression of given note
id.
+ The body field of the returned JSON contains the cron expression and
<code>releaseResource</code> flag.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "body": {
+ "cron": "0 0/1 * * * ?",
+ "releaseResource": true
+ }
+}</pre></td>
+ </tr>
+ </table></p>
+
+<h2>Permission</h2>
+
+<h3>Get a note permission information</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method gets a note authorization information.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/permissions</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Forbidden code</td>
+ <td>403</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{<br>
+ "status":"OK",
+ "message":"",
+ "body":{<br>
+ "readers":[<br>
+ "user2"
+ ],
+ "owners":[<br>
+ "user1"
+ ],
+ "runners":[
+ "user2"
+ ],
+ "writers":[<br>
+ "user2"
+ ]
+ }
+}
+ </pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Set note permission</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method set note authorization information.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/permissions</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Forbidden code</td>
+ <td>403</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td> sample JSON input </td>
+ <td><pre>
+{
+ "readers": [
+ "user1"
+ ],
+ "owners": [
+ "user2"
+ ],
+ "runners":[
+ "user2"
+ ],
+ "writers": [
+ "user1"
+ ]
+}
+</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK"
+}</pre></td>
+ </tr>
+ </table></p>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2019 The Apache Software Foundation</p>-->
+ </footer>
+ </div>
+
+
+
+
+ <script type="text/javascript">
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new
Date();a=s.createElement(o),
+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-45176241-5', 'zeppelin.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+
Propchange: zeppelin/site/docs/0.8.2/usage/rest_api/notebook.html
------------------------------------------------------------------------------
svn:executable = *
Added: zeppelin/site/docs/0.8.2/usage/rest_api/notebook_repository.html
URL:
http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.2/usage/rest_api/notebook_repository.html?rev=1867691&view=auto
==============================================================================
--- zeppelin/site/docs/0.8.2/usage/rest_api/notebook_repository.html (added)
+++ zeppelin/site/docs/0.8.2/usage/rest_api/notebook_repository.html Sun Sep 29
07:08:10 2019
@@ -0,0 +1,448 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.8.0 Documentation: Apache Zeppelin notebook
repository REST API</title>
+ <meta name="description" content="This page contains Apache Zeppelin
notebook repository REST API information.">
+ <meta name="author" content="The Apache Software Foundation">
+
+ <!-- Enable responsive viewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js";></script>
+ <![endif]-->
+
+ <link
href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css"
rel="stylesheet">
+
+ <!-- Le styles -->
+ <link href="/docs/0.8.0/assets/themes//bootstrap/css/bootstrap.css"
rel="stylesheet">
+ <link href="/docs/0.8.0/assets/themes//css/style.css?body=1"
rel="stylesheet" type="text/css">
+ <link href="/docs/0.8.0/assets/themes//css/syntax.css" rel="stylesheet"
type="text/css" media="screen" />
+ <!-- Le fav and touch icons -->
+ <!-- Update these with your own images
+ <link rel="shortcut icon" href="images/favicon.ico">
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72"
href="images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114"
href="images/apple-touch-icon-114x114.png">
+ -->
+
+ <!-- Js -->
+ <script src="https://code.jquery.com/jquery-1.10.2.min.js";></script>
+ <script
src="/docs/0.8.0/assets/themes//bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/docs.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/anchor.min.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/toc.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/lunr.min.js"></script>
+ <script src="/docs/0.8.0/assets/themes//js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.8.0/atom.xml" type="application/atom+xml"
rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.8.0/rss.xml" type="application/rss+xml"
rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div id="menu" class="navbar navbar-inverse navbar-fixed-top"
role="navigation">
+ <div class="container navbar-container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse"
data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <div class="navbar-brand">
+ <a class="navbar-brand-main" href="http://zeppelin.apache.org";>
+ <img
src="/docs/0.8.0/assets/themes/zeppelin/img/zeppelin_logo.png" width="50"
+ style="margin-top: -2px;" alt="I'm zeppelin">
+ <span style="margin-left: 5px; font-size: 27px;">Zeppelin</span>
+ <a class="navbar-brand-version" href="/docs/0.8.0"
+ style="font-size: 15px; color: white;"> 0.8.0
+ </a>
+ </a>
+ </div>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick
Start <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span>Getting Started</span></li>
+ <li><a
href="/docs/0.8.0/quickstart/install.html">Install</a></li>
+ <li><a href="/docs/0.8.0/quickstart/explore_ui.html">Explore
UI</a></li>
+ <li><a
href="/docs/0.8.0/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a
href="/docs/0.8.0/quickstart/spark_with_zeppelin.html">Spark with
Zeppelin</a></li>
+ <li><a
href="/docs/0.8.0/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li>
+ <li><a
href="/docs/0.8.0/quickstart/python_with_zeppelin.html">Python with
Zeppelin</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown"
class="dropdown-toggle">Usage<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Dynamic Form</span></li>
+ <li><a href="/docs/0.8.0/usage/dynamic_form/intro.html">What
is Dynamic Form?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Display System</span></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/basic.html#text">Text Display</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/basic.html#html">HTML Display</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/basic.html#table">Table Display</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/basic.html#network">Network
Display</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/angular_backend.html">Angular Display
using Backend API</a></li>
+ <li><a
href="/docs/0.8.0/usage/display_system/angular_frontend.html">Angular Display
using Frontend API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Interpreter</span></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/overview.html">Overview</a></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/interpreter_binding_mode.html">Interpreter
Binding Mode</a></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/user_impersonation.html">User
Impersonation</a></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/dependency_management.html">Dependency
Management</a></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/installation.html">Installing
Interpreters</a></li>
+ <!--<li><a
href="/docs/0.8.0/usage/interpreter/dynamic_loading.html">Dynamic Interpreter
Loading (Experimental)</a></li>-->
+ <li><a
href="/docs/0.8.0/usage/interpreter/execution_hooks.html">Execution Hooks
(Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Other Features</span></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/publishing_paragraphs.html">Publishing
Paragraphs</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/personalized_mode.html">Personalized
Mode</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/customizing_homepage.html">Customizing
Zeppelin Homepage</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/notebook_actions.html">Notebook
Actions</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/cron_scheduler.html">Cron
Scheduler</a></li>
+ <li><a
href="/docs/0.8.0/usage/other_features/zeppelin_context.html">Zeppelin
Context</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>REST API</span></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/interpreter.html">Interpreter API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/zeppelin_server.html">Zeppelin Server
API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/notebook.html">Notebook API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/notebook_repository.html">Notebook Repository
API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/configuration.html">Configuration API</a></li>
+ <li><a
href="/docs/0.8.0/usage/rest_api/credential.html">Credential API</a></li>
+ <li><a href="/docs/0.8.0/usage/rest_api/helium.html">Helium
API</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown"
class="dropdown-toggle">Setup<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Basics</span></li>
+ <li><a href="/docs/0.8.0/setup/basics/how_to_build.html">How
to Build Zeppelin</a></li>
+ <li><a
href="/docs/0.8.0/setup/basics/multi_user_support.html">Multi-user
Support</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Deployment</span></li>
+ <!--<li><a
href="/docs/0.8.0/setup/deployment/docker.html">Docker Image for
Zeppelin</a></li>-->
+ <li><a
href="/docs/0.8.0/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark
Cluster Mode: Standalone</a></li>
+ <li><a
href="/docs/0.8.0/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark
Cluster Mode: YARN</a></li>
+ <li><a
href="/docs/0.8.0/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark
Cluster Mode: Mesos</a></li>
+ <li><a
href="/docs/0.8.0/setup/deployment/flink_and_spark_cluster.html">Zeppelin with
Flink, Spark Cluster</a></li>
+ <li><a href="/docs/0.8.0/setup/deployment/cdh.html">Zeppelin
on CDH</a></li>
+ <li><a
href="/docs/0.8.0/setup/deployment/virtual_machine.html">Zeppelin on VM:
Vagrant</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Security</span></li>
+ <li><a
href="/docs/0.8.0/setup/security/authentication_nginx.html">HTTP Basic Auth
using NGINX</a></li>
+ <li><a
href="/docs/0.8.0/setup/security/shiro_authentication.html">Shiro
Authentication</a></li>
+ <li><a
href="/docs/0.8.0/setup/security/notebook_authorization.html">Notebook
Authorization</a></li>
+ <li><a
href="/docs/0.8.0/setup/security/datasource_authorization.html">Data Source
Authorization</a></li>
+ <li><a
href="/docs/0.8.0/setup/security/http_security_headers.html">HTTP Security
Headers</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Notebook Storage</span></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git
Storage</a></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-s3">S3
Storage</a></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-azure">Azure
Storage</a></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-zeppelinhub">ZeppelinHub
Storage</a></li>
+ <li><a
href="/docs/0.8.0/setup/storage/storage.html#notebook-storage-in-mongodb">MongoDB
Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Operation</span></li>
+ <li><a
href="/docs/0.8.0/setup/operation/configuration.html">Configuration</a></li>
+ <li><a
href="/docs/0.8.0/setup/operation/proxy_setting.html">Proxy Setting</a></li>
+ <li><a
href="/docs/0.8.0/setup/operation/upgrading.html">Upgrading</a></li>
+ <li><a
href="/docs/0.8.0/setup/operation/trouble_shooting.html">Trouble
Shooting</a></li>
+ </ul>
+ </li>
+
+ <li>
+ <a href="#" data-toggle="dropdown"
class="dropdown-toggle">Interpreter <b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu">
+ <li class="title"><span>Interpreters</span></li>
+ <li><a
href="/docs/0.8.0/usage/interpreter/overview.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.8.0/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.8.0/interpreter/jdbc.html">JDBC</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/python.html">Python</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a
href="/docs/0.8.0/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.8.0/interpreter/beam.html">Beam</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.8.0/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.8.0/interpreter/geode.html">Geode</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/groovy.html">Groovy</a></li>
+ <li><a href="/docs/0.8.0/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.8.0/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.8.0/interpreter/hive.html">Hive</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.8.0/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.8.0/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.8.0/interpreter/livy.html">Livy</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.8.0/interpreter/neo4j.html">Neo4j</a></li>
+ <li><a href="/docs/0.8.0/interpreter/pig.html">Pig</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.8.0/interpreter/r.html">R</a></li>
+ <li><a
href="/docs/0.8.0/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.8.0/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.8.0/interpreter/shell.html">Shell</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown"
class="dropdown-toggle">More<b class="caret"></b></a>
+ <ul class="dropdown-menu scrollable-menu" style="right: 0; left:
auto;">
+ <li class="title"><span>Extending Zeppelin</span></li>
+ <li><a
href="/docs/0.8.0/development/writing_zeppelin_interpreter.html">Writing
Zeppelin Interpreter</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Helium (Experimental)</span></li>
+ <li><a
href="/docs/0.8.0/development/helium/overview.html">Overview</a></li>
+ <li><a
href="/docs/0.8.0/development/helium/writing_application.html">Writing Helium
Application</a></li>
+ <li><a
href="/docs/0.8.0/development/helium/writing_spell.html">Writing Helium
Spell</a></li>
+ <li><a
href="/docs/0.8.0/development/helium/writing_visualization_basic.html">Writing
Helium Visualization: Basics</a></li>
+ <li><a
href="/docs/0.8.0/development/helium/writing_visualization_transformation.html">Writing
Helium Visualization: Transformation</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>Contributing to Zeppelin</span></li>
+ <li><a href="/docs/0.8.0/setup/basics/how_to_build.html">How
to Build Zeppelin</a></li>
+ <li><a
href="/docs/0.8.0/development/contribution/useful_developer_tools.html">Useful
Developer Tools</a></li>
+ <li><a
href="/docs/0.8.0/development/contribution/how_to_contribute_code.html">How to
Contribute (code)</a></li>
+ <li><a
href="/docs/0.8.0/development/contribution/how_to_contribute_website.html">How
to Contribute (website)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span>External Resources</span></li>
+ <li><a target="_blank" href="">Mailing List</a></li>
+ <li><a target="_blank" href="">Apache Zeppelin Wiki</a></li>
+ <li><a target="_blank" href="">Stackoverflow Questions about
Zeppelin</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.8.0/search.html" class="nav-search-link">
+ <span class="fa fa-search nav-search-icon"></span>
+ </a>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+
+ <div class="content">
+
+<!--<div class="hero-unit Apache Zeppelin notebook repository REST API">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<h1>Apache Zeppelin Notebook Repository API</h1>
+
+<div id="toc"></div>
+
+<h2>Overview</h2>
+
+<p>Apache Zeppelin provides several REST APIs for interaction and remote
activation of zeppelin functionality.
+All REST APIs are available starting with the following endpoint
<code>http://[zeppelin-server]:[zeppelin-port]/api</code>.
+Note that Apache Zeppelin REST APIs receive or return JSON objects, it is
recommended for you to install some JSON viewers such as <a
href="https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc";>JSONView</a>.</p>
+
+<p>If you work with Apache Zeppelin and find a need for an additional REST
API, please <a href="http://zeppelin.apache.org/community.html";>file an issue
or send us an email</a>.</p>
+
+<h2>Notebook Repository REST API List</h2>
+
+<h3>List all available notebook repositories</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method returns all the available notebook
repositories.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td>Sample JSON response</td>
+ <td>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": [
+ {
+ "name": "GitNotebookRepo",
+ "className":
"org.apache.zeppelin.notebook.repo.GitNotebookRepo",
+ "settings": [
+ {
+ "type": "INPUT",
+ "value": [],
+ "selected": "ZEPPELIN_HOME/zeppelin/notebook/",
+ "name": "Notebook Path"
+ }
+ ]
+ }
+ ]
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Reload a notebook repository</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method triggers reloading and broadcasting of
the note list.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories/reload</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>500</td>
+ </tr>
+ <tr>
+ <td>Sample JSON response</td>
+ <td>
+ <pre>
+{
+ "status": "OK",
+ "message": ""
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Update a specific notebook repository</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method updates a specific notebook
repository.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td>
+ 404 when the specified notebook repository doesn't exist <br/>
+ 406 for invalid payload <br/>
+ 500 for any other errors
+ </td>
+ </tr>
+ <tr>
+ <td>Sample JSON input</td>
+ <td>
+ <pre>
+{
+
"name":"org.apache.zeppelin.notebook.repo.GitNotebookRepo",
+ "settings":{
+ "Notebook Path":"/tmp/notebook/"
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ <tr>
+ <td>Sample JSON response</td>
+ <td>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "name": "GitNotebookRepo",
+ "className":
"org.apache.zeppelin.notebook.repo.GitNotebookRepo",
+ "settings": [
+ {
+ "type": "INPUT",
+ "value": [],
+ "selected": "/tmp/notebook/",
+ "name": "Notebook Path"
+ }
+ ]
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2019 The Apache Software Foundation</p>-->
+ </footer>
+ </div>
+
+
+
+
+ <script type="text/javascript">
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new
Date();a=s.createElement(o),
+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-45176241-5', 'zeppelin.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+
Propchange: zeppelin/site/docs/0.8.2/usage/rest_api/notebook_repository.html
------------------------------------------------------------------------------
svn:executable = *
