You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by ti...@apache.org on 2013/11/18 07:09:27 UTC
svn commit: r1542910 [22/36] - in /incubator/usergrid/site/publish: ./
bootstrap/ bootstrap/bootstrap/ community/ css/ css/bootflat-extensions/
css/bootflat-square/ css/bootflat/ css/font-awesome/ css/usergrid-site/
docs/ docs/access-token/ docs/activi...
Added: incubator/usergrid/site/publish/docs/querying-your-app-services-data/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/querying-your-app-services-data/index.html?rev=1542910&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/querying-your-app-services-data/index.html (added)
+++ incubator/usergrid/site/publish/docs/querying-your-app-services-data/index.html Mon Nov 18 06:09:23 2013
@@ -0,0 +1,280 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) â Querying your Apache Usergrid data</title>
+ <meta http-equiv="x-ua-compatible" content="ie=edge" />
+ <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" />
+ <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service">
+ <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <meta property="og:title" content="Apache Usergrid" />
+ <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <!-- Loading Typekit -->
+ <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script>
+ <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
+ <!-- Loading Bootstrap -->
+ <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'>
+ <link href="/css/bootflat.css" rel="stylesheet" type='text/css'>
+ <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'>
+ <link href="http://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic" rel="stylesheet" type="text/css">
+ <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
+
+
+
+ <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
+ <!--[if lt IE 9]>
+ <script src="js/html5shiv.js"></script>
+ <script src="js/respond.min.js"></script>
+ <![endif]-->
+</head>
+<body>
+
+ <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner">
+ <div class="container">
+ <div class="navbar-header">
+ <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-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>
+ <a href="/" class="navbar-brand">
+ <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
+ </a>
+ </div>
+ <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
+ <ul class="nav navbar-nav navbar-right">
+ <!--<li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>-->
+ <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank"><span class="icns icon-github-sign"></span></a></li>
+ <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span class="icns icon-trello"></span></a></li>-->
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank"><span class="icns icon-bug"></span></a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank"><span class="icns icon-stackexchange"></span></a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4" target="_blank"><span class="icns icon-comments"></span></a></li>
+ <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid" target="_blank"><span class="icns icon-envelope"></span></a></li>-->
+ <li><a href="https://twitter.com/usergrid" target="_blank"><span class="icns icon-twitter"></span></a></li>
+ </ul>
+ </nav>
+ </div>
+ </header>
+
+
+<div class="container bf-docs-container">
+ <div class="row">
+ <div class="col-md-3">
+ <div class="bf-sidebar hidden-print" role="complementary">
+ <ul class="nav nav-list">
+ <li><a href="#">Getting Up & Running Locally</a></li>
+ <li><a href="#"><code>ugc</code> â the Command-line Client</a></li>
+
+ <li class="nav-header"><span>Concepts</span></li>
+ <li>
+ <a href="/docs/organizations-admins/">Organizations & Admins</a>
+ <ul>
+ <li>
+ <a href="/docs/applications">Applications</a>
+ <ul>
+ <li><a href="#">Roles & Permissions</a></li>
+ <li><a href="#">Queues</a></li>
+ <li><a href="#">Events & Counters</a></li>
+ <li>
+ <a href="#">Collections</a>
+ <ul>
+ <li><a href="#">Query Language</a></li>
+ <li><a href="#">Users & Devices</a></li>
+ <li><a href="#">Groups</a></li>
+ <li><a href="#">Activities</a></li>
+ <li><a href="#">Assets</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-header"><span>Usage</span></li>
+ <li><a href="/docs/rest-api">REST API</a></li>
+ <li><a class="icns-apple" href="#">iOS SDK</a></li>
+ <li><a class="icns-android" href="#">Android SDK</a></li>
+ <li><a class="icns-html5" href="/docs/html5-javascript-sdk">HTML5 / JavaScript SDK</a></li>
+ <li><a class="icns-windows" href="#">Windows 8 / Windows Phone / .net SDK</a></li>
+ <li><a href="/docs/nodejs-module">Node.js module</a></li>
+ <li><a href="/docs/ruby-gem">Ruby gem</a></li>
+ <li><a href="#">Ruby on Rails gem</a></li>
+ <li><a href="#">PHP library</a></li>
+
+ <li class="nav-header"><span>Internals</span></li>
+ <li><a href="#">Design & Goals</a></li>
+ <li><a href="#">Java Architecture</a></li>
+ <li><a href="#">Cassandra Schema</a></li>
+ <li><a href="#">Contributing</a></li>
+
+ <li class="nav-header"><span>Operations</span></li>
+ <li><a href="#">Deploying</a></li>
+ <li><a href="#">Monitoring</a></li>
+ <li><a href="#">Upgrading</a></li>
+ <li><a href="#">Security</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div class="col-md-9 main-article" role="main">
+ <div class="page-article">
+ <div class="page-header">
+ <h1>Querying your Apache Usergrid data</h1>
+ <small><a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/querying-your-app-services-data/">contribute to this article on github</a></small>
+ </div>
+ <div class="toc">
+ <ul>
+<li>
+<a href="#querying-your-apache-usergrid-data">Querying your Apache Usergrid data</a><ul>
+<li><a href="#querying-data-from-the-admin-portal">Querying data from the admin portal</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<h1 id="querying-your-apache-usergrid-data"><a href="#querying-your-apache-usergrid-data">Querying your Apache Usergrid data</a></h1>
+<p>You can write code to query for data youâve stored in your Apache Usergrid application. Youâll most likely use queries as filters to retrieve specific entities. For example, you might want to get data about users who are âfollowingâ a specific other user, businesses in specific geographical locations, and so on.</p>
+<p>The following example retrieves a list of restaurants (from a restaurants collection) whose name property contains the value âdinerâ, sorting the list in ascending order by name:</p>
+<pre><code>/restaurants?ql=select * where name contains 'diner' order by name asc</code></pre>
+<p>Having retrieved the list of restaurants, your code could display the list to your users. You could also use a query to retrieve a list of diners that are located within a particular geographical area (such as near your userâs current location).</p>
+<blockquote>
+<p><strong>Important:</strong> By default, results from queries of your Apache Usergrid data are limited to 10 items at a time. You can control this with the <code>limit</code> parameter, as discussed <a href="/working-queries#cursor">Working with queries</a>.</p>
+</blockquote>
+<p>You query your Apache Usergrid data by using a query syntax thatâs like Structured Query Language (SQL), the query language for relational databases. Unlike a relational database, where you specify tables and columns containing the data you want to query, in your Apache Usergrid queries you specify collections and entities.</p>
+<p>The examples in this section illustrate queries using simple strings to make the queries easier to read. You can also use one of the Apigee SDKs, which provide functions through which you can pass query strings, and in some cases shortcuts for bypassing queries altogether.</p>
+<p><strong>Note:</strong> Queries replace filters, which are deprecated.</p>
+<h2 id="querying-data-from-the-admin-portal"><a href="#querying-data-from-the-admin-portal">Querying data from the admin portal</a></h2>
+<p>The easiest way to try out queries youâre considering is to use the admin portal, which you can reach at <a href="https://apigee.com/usergrid/">https://apigee.com/usergrid/</a>.</p>
+<p>To try out queries in the portal, use the following steps:</p>
+<ol style="list-style-type: decimal">
+<li>
+<p>Go to the <strong>Data Explorer</strong> using the left navigation pane.</p>
+<div class="figure">
+<embed src="/docs/sites/docs/files/styles/large/public/as_push_console_delete.png?itok=BFAfMReE"></embed>
+</div>
+</li>
+<li>Under <strong>Method</strong>, select the HTTP method you want to use, as follows:<br>- GET to retrieve data.
+<ul>
+<li>POST to create data.</li>
+<li>PUT to update data.</li>
+<li>DELETE to delete data.</li>
+</ul>
+</li>
+<li>In the <strong>Path</strong> box, enter the path to the collection youâre querying.</li>
+<li>
+<p>In the <strong>Query String</strong> box, enter your query string.</p>
+<p>Note that you put the path and query string in separate fields, rather than appending the query string to the path in the <strong>Path</strong> box.</p>
+</li>
+</ol><p>The admin portal transforms queries into standard URL-encoded parameters before issuing HTTP requests. For example, given the following query resulting from what youâve entered in the portal:</p>
+<pre><code>/users?ql=select * where name = 'gladys*'</code></pre>
+<p>The string received by Apigee would be the following:</p>
+<pre><code>/users?ql=select%20*%20where%20name%20%3d%20'gladys*'</code></pre>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-3"></div>
+ <div class="col-md-9">
+ <div class="github-callout">
+ <strong>Questions?</strong> Please do <a href="https://groups.google.com/forum/#!forum/usergrid">ask on the mailing-list</a>!<br/>
+ <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/querying-your-app-services-data/">this article on github</a>.</div>
+ </div>
+ </div>
+</div>
+
+
+<footer class="bf-footer" role="contentinfo">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="/">Home</a></li>
+ <li class="nav-header"><a href="/community/">Community</a></li>
+ <!-- <li><a href="/community#events">Events</a></li> -->
+ <li><a href="/community/#mailing-lists">Mailing Lists</a></li>
+ <li><a href="/community/#deployments">Deployments</a></li>
+ <li><a href="/community/#committers">Commiters</a></li>
+ <!-- <li class="nav-header"><a href="#">Docs</a></li> -->
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="https://github.com/usergrid/usergrid/" target="_blank">Code</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet" target="_blank">.NET / Windows SDK</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header">Resources</li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank">GitHub Code</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank">JIRA Bug Tracker</a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4">IRC</a></li>
+ <li><a href="https://twitter.com/usergrid" target="_blank">Twitter</a></li>
+ <li><a href="http://incubator.apache.org/projects/usergrid.html" target="_blank">Podling Listing</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/LICENSE" target="_blank">License</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#contributing" target="_blank">Contribution Guidelines</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2"></div>
+ <div class="col-md-4">
+ <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid" data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a>
+ <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ </div>
+ <!--
+ <div class="col-md-4">
+ <div class="input-group form-search">
+ <input type="text" class="form-control search-query">
+ <span class="input-group-btn">
+ <button type="submit" class="btn btn-primary" data-type="last">Search</button>
+ </span>
+ </div>
+ </div> -->
+ </div>
+ <div class="row">
+ <div id="copyright">
+ <img src="/img/egg-logo.png" /><br/><br/>
+ <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
+ <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br>
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p>
+ <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee">@ryuneeee</a> + <a href="https://github.com/realbeast">@realbeast</a> + <a href="https://twitter.com/timanglade">@timanglade</a>.</p>
+ </div>
+ </div>
+ </div>
+</footer>
+
+<script type="text/javascript" src="/js/head.js"></script>
+<script type="text/javascript">
+ head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js");
+</script>
+<script type="text/javascript">
+ //IE outdate friendly warning if you don't want remove it
+ var $buoop = {vs:{i:8,f:3.6,o:10.6,s:3.2,n:9}}
+ $buoop.ol = window.onload;
+ window.onload=function(){
+ try {if ($buoop.ol) $buoop.ol();}catch (e) {}
+ var e = document.createElement("script");
+ e.setAttribute("type", "text/javascript");
+ e.setAttribute("src", "http://browser-update.org/update.js");
+ document.body.appendChild(e);
+ }
+</script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/docs/rest-api/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/rest-api/index.html?rev=1542910&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/rest-api/index.html (added)
+++ incubator/usergrid/site/publish/docs/rest-api/index.html Mon Nov 18 06:09:23 2013
@@ -0,0 +1,246 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) â REST API</title>
+ <meta http-equiv="x-ua-compatible" content="ie=edge" />
+ <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" />
+ <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service">
+ <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <meta property="og:title" content="Apache Usergrid" />
+ <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <!-- Loading Typekit -->
+ <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script>
+ <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
+ <!-- Loading Bootstrap -->
+ <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'>
+ <link href="/css/bootflat.css" rel="stylesheet" type='text/css'>
+ <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'>
+ <link href="http://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic" rel="stylesheet" type="text/css">
+ <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
+
+
+
+ <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
+ <!--[if lt IE 9]>
+ <script src="js/html5shiv.js"></script>
+ <script src="js/respond.min.js"></script>
+ <![endif]-->
+</head>
+<body>
+
+ <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner">
+ <div class="container">
+ <div class="navbar-header">
+ <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-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>
+ <a href="/" class="navbar-brand">
+ <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
+ </a>
+ </div>
+ <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
+ <ul class="nav navbar-nav navbar-right">
+ <!--<li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>-->
+ <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank"><span class="icns icon-github-sign"></span></a></li>
+ <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span class="icns icon-trello"></span></a></li>-->
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank"><span class="icns icon-bug"></span></a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank"><span class="icns icon-stackexchange"></span></a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4" target="_blank"><span class="icns icon-comments"></span></a></li>
+ <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid" target="_blank"><span class="icns icon-envelope"></span></a></li>-->
+ <li><a href="https://twitter.com/usergrid" target="_blank"><span class="icns icon-twitter"></span></a></li>
+ </ul>
+ </nav>
+ </div>
+ </header>
+
+
+<div class="container bf-docs-container">
+ <div class="row">
+ <div class="col-md-3">
+ <div class="bf-sidebar hidden-print" role="complementary">
+ <ul class="nav nav-list">
+ <li><a href="#">Getting Up & Running Locally</a></li>
+ <li><a href="#"><code>ugc</code> â the Command-line Client</a></li>
+
+ <li class="nav-header"><span>Concepts</span></li>
+ <li>
+ <a href="/docs/organizations-admins/">Organizations & Admins</a>
+ <ul>
+ <li>
+ <a href="/docs/applications">Applications</a>
+ <ul>
+ <li><a href="#">Roles & Permissions</a></li>
+ <li><a href="#">Queues</a></li>
+ <li><a href="#">Events & Counters</a></li>
+ <li>
+ <a href="#">Collections</a>
+ <ul>
+ <li><a href="#">Query Language</a></li>
+ <li><a href="#">Users & Devices</a></li>
+ <li><a href="#">Groups</a></li>
+ <li><a href="#">Activities</a></li>
+ <li><a href="#">Assets</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-header"><span>Usage</span></li>
+ <li><a href="/docs/rest-api">REST API</a></li>
+ <li><a class="icns-apple" href="#">iOS SDK</a></li>
+ <li><a class="icns-android" href="#">Android SDK</a></li>
+ <li><a class="icns-html5" href="/docs/html5-javascript-sdk">HTML5 / JavaScript SDK</a></li>
+ <li><a class="icns-windows" href="#">Windows 8 / Windows Phone / .net SDK</a></li>
+ <li><a href="/docs/nodejs-module">Node.js module</a></li>
+ <li><a href="/docs/ruby-gem">Ruby gem</a></li>
+ <li><a href="#">Ruby on Rails gem</a></li>
+ <li><a href="#">PHP library</a></li>
+
+ <li class="nav-header"><span>Internals</span></li>
+ <li><a href="#">Design & Goals</a></li>
+ <li><a href="#">Java Architecture</a></li>
+ <li><a href="#">Cassandra Schema</a></li>
+ <li><a href="#">Contributing</a></li>
+
+ <li class="nav-header"><span>Operations</span></li>
+ <li><a href="#">Deploying</a></li>
+ <li><a href="#">Monitoring</a></li>
+ <li><a href="#">Upgrading</a></li>
+ <li><a href="#">Security</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div class="col-md-9 main-article" role="main">
+ <div class="page-article">
+ <div class="page-header">
+ <h1>REST API</h1>
+ <small><a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/rest-api/">contribute to this article on github</a></small>
+ </div>
+ <div class="toc">
+ <ul>
+<li><a href="#organizations">Organizations</a></li>
+</ul>
+</div>
+<h2 id="organizations"><a href="#organizations">Organizations</a></h2>
+<pre class="highlight"><code class="language-bash"><span class="c"># Create an Organization</span>
+curl -X POST <span class="s2">"https://api.usergrid.com/management/organizations"</span> <span class="se">\</span>
+ -d <span class="s1">'{ "password":"test12345", "email":"tester123@hotmail.com", "name":"test", "username":"test123", "organization":"testorg" }'</span>
+
+<span class="c"># Read an Organization</span>
+curl -X GET <span class="s2">"https://api.usergrid.com/management/organizations/testorg"</span></code></pre>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-3"></div>
+ <div class="col-md-9">
+ <div class="github-callout">
+ <strong>Questions?</strong> Please do <a href="https://groups.google.com/forum/#!forum/usergrid">ask on the mailing-list</a>!<br/>
+ <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/rest-api/">this article on github</a>.</div>
+ </div>
+ </div>
+</div>
+
+
+<footer class="bf-footer" role="contentinfo">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="/">Home</a></li>
+ <li class="nav-header"><a href="/community/">Community</a></li>
+ <!-- <li><a href="/community#events">Events</a></li> -->
+ <li><a href="/community/#mailing-lists">Mailing Lists</a></li>
+ <li><a href="/community/#deployments">Deployments</a></li>
+ <li><a href="/community/#committers">Commiters</a></li>
+ <!-- <li class="nav-header"><a href="#">Docs</a></li> -->
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="https://github.com/usergrid/usergrid/" target="_blank">Code</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet" target="_blank">.NET / Windows SDK</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header">Resources</li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank">GitHub Code</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank">JIRA Bug Tracker</a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4">IRC</a></li>
+ <li><a href="https://twitter.com/usergrid" target="_blank">Twitter</a></li>
+ <li><a href="http://incubator.apache.org/projects/usergrid.html" target="_blank">Podling Listing</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/LICENSE" target="_blank">License</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#contributing" target="_blank">Contribution Guidelines</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2"></div>
+ <div class="col-md-4">
+ <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid" data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a>
+ <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ </div>
+ <!--
+ <div class="col-md-4">
+ <div class="input-group form-search">
+ <input type="text" class="form-control search-query">
+ <span class="input-group-btn">
+ <button type="submit" class="btn btn-primary" data-type="last">Search</button>
+ </span>
+ </div>
+ </div> -->
+ </div>
+ <div class="row">
+ <div id="copyright">
+ <img src="/img/egg-logo.png" /><br/><br/>
+ <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
+ <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br>
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p>
+ <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee">@ryuneeee</a> + <a href="https://github.com/realbeast">@realbeast</a> + <a href="https://twitter.com/timanglade">@timanglade</a>.</p>
+ </div>
+ </div>
+ </div>
+</footer>
+
+<script type="text/javascript" src="/js/head.js"></script>
+<script type="text/javascript">
+ head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js");
+</script>
+<script type="text/javascript">
+ //IE outdate friendly warning if you don't want remove it
+ var $buoop = {vs:{i:8,f:3.6,o:10.6,s:3.2,n:9}}
+ $buoop.ol = window.onload;
+ window.onload=function(){
+ try {if ($buoop.ol) $buoop.ol();}catch (e) {}
+ var e = document.createElement("script");
+ e.setAttribute("type", "text/javascript");
+ e.setAttribute("src", "http://browser-update.org/update.js");
+ document.body.appendChild(e);
+ }
+</script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/docs/rest-endpoints/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/rest-endpoints/index.html?rev=1542910&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/rest-endpoints/index.html (added)
+++ incubator/usergrid/site/publish/docs/rest-endpoints/index.html Mon Nov 18 06:09:23 2013
@@ -0,0 +1,680 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) â REST Endpoints</title>
+ <meta http-equiv="x-ua-compatible" content="ie=edge" />
+ <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" />
+ <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service">
+ <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <meta property="og:title" content="Apache Usergrid" />
+ <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <!-- Loading Typekit -->
+ <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script>
+ <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
+ <!-- Loading Bootstrap -->
+ <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'>
+ <link href="/css/bootflat.css" rel="stylesheet" type='text/css'>
+ <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'>
+ <link href="http://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic" rel="stylesheet" type="text/css">
+ <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
+
+
+
+ <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
+ <!--[if lt IE 9]>
+ <script src="js/html5shiv.js"></script>
+ <script src="js/respond.min.js"></script>
+ <![endif]-->
+</head>
+<body>
+
+ <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner">
+ <div class="container">
+ <div class="navbar-header">
+ <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-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>
+ <a href="/" class="navbar-brand">
+ <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
+ </a>
+ </div>
+ <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
+ <ul class="nav navbar-nav navbar-right">
+ <!--<li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>-->
+ <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank"><span class="icns icon-github-sign"></span></a></li>
+ <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span class="icns icon-trello"></span></a></li>-->
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank"><span class="icns icon-bug"></span></a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank"><span class="icns icon-stackexchange"></span></a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4" target="_blank"><span class="icns icon-comments"></span></a></li>
+ <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid" target="_blank"><span class="icns icon-envelope"></span></a></li>-->
+ <li><a href="https://twitter.com/usergrid" target="_blank"><span class="icns icon-twitter"></span></a></li>
+ </ul>
+ </nav>
+ </div>
+ </header>
+
+
+<div class="container bf-docs-container">
+ <div class="row">
+ <div class="col-md-3">
+ <div class="bf-sidebar hidden-print" role="complementary">
+ <ul class="nav nav-list">
+ <li><a href="#">Getting Up & Running Locally</a></li>
+ <li><a href="#"><code>ugc</code> â the Command-line Client</a></li>
+
+ <li class="nav-header"><span>Concepts</span></li>
+ <li>
+ <a href="/docs/organizations-admins/">Organizations & Admins</a>
+ <ul>
+ <li>
+ <a href="/docs/applications">Applications</a>
+ <ul>
+ <li><a href="#">Roles & Permissions</a></li>
+ <li><a href="#">Queues</a></li>
+ <li><a href="#">Events & Counters</a></li>
+ <li>
+ <a href="#">Collections</a>
+ <ul>
+ <li><a href="#">Query Language</a></li>
+ <li><a href="#">Users & Devices</a></li>
+ <li><a href="#">Groups</a></li>
+ <li><a href="#">Activities</a></li>
+ <li><a href="#">Assets</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-header"><span>Usage</span></li>
+ <li><a href="/docs/rest-api">REST API</a></li>
+ <li><a class="icns-apple" href="#">iOS SDK</a></li>
+ <li><a class="icns-android" href="#">Android SDK</a></li>
+ <li><a class="icns-html5" href="/docs/html5-javascript-sdk">HTML5 / JavaScript SDK</a></li>
+ <li><a class="icns-windows" href="#">Windows 8 / Windows Phone / .net SDK</a></li>
+ <li><a href="/docs/nodejs-module">Node.js module</a></li>
+ <li><a href="/docs/ruby-gem">Ruby gem</a></li>
+ <li><a href="#">Ruby on Rails gem</a></li>
+ <li><a href="#">PHP library</a></li>
+
+ <li class="nav-header"><span>Internals</span></li>
+ <li><a href="#">Design & Goals</a></li>
+ <li><a href="#">Java Architecture</a></li>
+ <li><a href="#">Cassandra Schema</a></li>
+ <li><a href="#">Contributing</a></li>
+
+ <li class="nav-header"><span>Operations</span></li>
+ <li><a href="#">Deploying</a></li>
+ <li><a href="#">Monitoring</a></li>
+ <li><a href="#">Upgrading</a></li>
+ <li><a href="#">Security</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div class="col-md-9 main-article" role="main">
+ <div class="page-article">
+ <div class="page-header">
+ <h1>REST Endpoints</h1>
+ <small><a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/rest-endpoints/">contribute to this article on github</a></small>
+ </div>
+ <div class="toc">
+ <ul>
+<li>
+<a href="#rest-endpoints">REST Endpoints</a><ul>
+<li><a href="#base-url-httpsapi.usergrid.commanagement">Base URL: https://api.usergrid.com/management</a></li>
+<li><a href="#access-token">Access Token</a></li>
+<li><a href="#admin-users">Admin users</a></li>
+<li><a href="#applications">Applications</a></li>
+<li><a href="#client-authorization">Client authorization</a></li>
+<li><a href="#organizations">Organizations</a></li>
+<li><a href="#base-url-httpsapi.usergrid.com">Base URL: https://api.usergrid.com</a></li>
+<li><a href="#activities">Activities</a></li>
+<li><a href="#assets">Assets</a></li>
+<li><a href="#collections-other-than-users-groups-and-roles">Collections (other than users, groups, and roles)</a></li>
+<li><a href="#devices">Devices</a></li>
+<li><a href="#events">Events</a></li>
+<li><a href="#folders">Folders</a></li>
+<li><a href="#groups">Groups</a></li>
+<li><a href="#roles">Roles</a></li>
+<li><a href="#users">Users</a></li>
+<li><a href="#notifications-notifiers-and-receipts">Notifications, Notifiers, and Receipts</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<h1 id="rest-endpoints"><a href="#rest-endpoints">REST Endpoints</a></h1>
+<h3 id="base-url-httpsapi.usergrid.commanagement"><a href="#base-url-httpsapi.usergrid.commanagement">Base URL: https://api.usergrid.com/management</a></h3>
+<p>Â </p>
+<h3 id="access-token"><a href="#access-token">Access Token</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/token â{âgrant_typeâ:âclient_credentialsâ,âclient_idâ:â{client_id}â,âclient_secretâ:âclient_secretâ}â</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Obtain an access token (access type = organization)</p>
+<p><a href="/access-token">Detail</a></p>
+<p>/token â{âgrant_typeâ:âpasswordâ,âusernameâ:â{username}â:âpasswordâ=â{password}â}â</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Obtain an access token (access type = admin user)</p>
+<p><a href="/access-token">Detail</a></p>
+<p>/{org_id}/{app_id}/token â{âgrant_typeâ:âclient_credentialsâ,âclient_idâ:â{client_id}â,âclient_secretâ:â{client_secret}â}â</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Obtain an access token (access type = application)</p>
+<p><a href="/access-token">Detail</a></p>
+<p>{org_id}/{app_id}/token â{âgrant_typeâ:âpasswordâ,âusernameâ:â{username}â,âpasswordâ:â{password}â}â</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Obtain an access token (access type = application user)</p>
+<p><a href="/access-token">Detail</a></p>
+<h3 id="admin-users"><a href="#admin-users">Admin users</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/users</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Create an admin user</p>
+<p><a href="/docs/usergrid/content/admin-user#creating-an-admin-user">Detail</a></p>
+<p>/users/{user|username|email|uuid}</p>
+<p>PUT</p>
+<p>application/json</p>
+<p>Update an admin user</p>
+<p><a href="/docs/usergrid/content/admin-user#updating-an-admin-user">Detail</a></p>
+<p>/users/{user|username|email|uuid}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get an admin user</p>
+<p><a href="/docs/usergrid/content/admin-user#getting-an-admin-user">Detail</a></p>
+<p>/users/{user|username|email|uuid}/<br> password</p>
+<p>PUT</p>
+<p>application/json</p>
+<p>Set an admin userâs password</p>
+<p><a href="/docs/usergrid/content/admin-user#setting-an-admin-user-s-password">Detail</a></p>
+<p>users/resetpw</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Initiate the reset of an admin userâs password</p>
+<p><a href="/docs/usergrid/content/admin-user#setting-an-admin-user-s-password">Detail</a></p>
+<p>/users/resetpw</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Complete the reset of an admin userâs password</p>
+<p><a href="/docs/usergrid/content/admin-user#setting-an-admin-user-s-password">Detail</a></p>
+<p>/users/{user|username|email|uuid}/activate?<br> token={token}&confirm={confirm_email}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Activate an admin user</p>
+<p><a href="/docs/usergrid/content/admin-user#activating-an-admin-user">Detail</a></p>
+<p>/users/{user|username|email|uuid}/reactivate</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Reactivate an admin user</p>
+<p><a href="/docs/usergrid/content/admin-user#reactivating-an-admin-user">Detail</a></p>
+<p>/users/{user|username|email|uuid}/feed</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get an admin userâs feed</p>
+<p><a href="/docs/usergrid/content/admin-user#getting-an-admin-user-s-activity-feed">Detail</a></p>
+<h3 id="applications"><a href="#applications">Applications</a></h3>
+<table><tbody><tr class="odd">
+<td align="left">See Organizations</td>
+</tr></tbody></table><h3 id="client-authorization"><a href="#client-authorization">Client authorization</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/authorize?response_type={response_type}&<br> client_id={client_id}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Authorize a client</p>
+<p><a href="/docs/usergrid/content/client-authorization">Detail</a></p>
+<h3 id="organizations"><a href="#organizations">Organizations</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/organizations|orgs</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Create an organization</p>
+<p><a href="/docs/usergrid/content/organization#creating-an-organization">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{uuid}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Retrieve an organization</p>
+<p><a href="/docs/usergrid/content/organization#getting-an-organization">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{uuid}/<br> activate?token={token}&confirm={confirm_email}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Activate an organization</p>
+<p><a href="/docs/usergrid/content/organization#activating-an-organization">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{uuid}/<br> reactivate</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Reactivate an organization</p>
+<p><a href="/docs/usergrid/content/organization#reactivating-an-organization">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{uuid}/<br> credentials</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Generate organization client credentials</p>
+<p><a href="/docs/usergrid/content/organization#generating-organization-client-credentials">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{uuid}/<br> credentials</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Retrieve organization client credentials</p>
+<p><a href="/docs/usergrid/content/organization#retrieving-organization-client-credentials">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{uuid}/<br> feed</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Retrieve an organizationâs activity feed</p>
+<p><a href="/docs/usergrid/content/organization#getting-an-organization-s-activity-feed">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{org_uuid}/<br> apps</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Create an organization application</p>
+<p><a href="/docs/usergrid/content/organization#creating-an-organization-application">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{org_uuid}/<br> apps/{app_name}|{app_uuid}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Delete an organization application</p>
+<p><a href="/docs/usergrid/content/organization#deleting-an-organization-application">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{uuid}/<br> applications|apps/{app_name}|{uuid}/<br> credentials</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Generate credentials for an organization application</p>
+<p><a href="/docs/usergrid/content/organization#generating-an-application-credentials">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{uuid}/<br> applications|apps/<br> {app_name}|{uuid}/credentials</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get credentials for an organization application</p>
+<p><a href="/docs/usergrid/content/organization#getting-application-credentials">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{uuid}/<br> applications|apps</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get the applications in an organization</p>
+<p><a href="/docs/usergrid/content/organization#getting-the-applications-in-an-organization">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{org_uuid}/<br> users/{username|email|uuid}</p>
+<p>PUT</p>
+<p>application/json</p>
+<p>Adding an admin user to an organization</p>
+<p><a href="/docs/usergrid/content/organization#adding-an-admin-user-to-an-organization">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{org_uuid}/ users</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Getting the admin users in an organization</p>
+<p><a href="/docs/usergrid/content/organization#getting-the-admin-users-in-an-organization">Detail</a></p>
+<p>/organizations|orgs/{org_name}|{org_uuid}/<br> users/{username|email|uuid}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Removing an admin user from an organization</p>
+<p><a href="/docs/usergrid/content/organization#removing-an-admin-user-from-an-organization">Detail</a></p>
+<h3 id="base-url-httpsapi.usergrid.com"><a href="#base-url-httpsapi.usergrid.com">Base URL: https://api.usergrid.com</a></h3>
+<h3 id="activities"><a href="#activities">Activities</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/{org_id}/{app_id}/users/<br> {uuid|username}/activities</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Create an activity</p>
+<p><a href="/docs/usergrid/content/activity#creating-an-activity">Detail</a></p>
+<p>/{org_id}/{app_id}/groups/<br> {uuid|groupname}/activities</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Post an activity to a group</p>
+<p><a href="/docs/usergrid/content/activity#posting-an-activity-to-a-group">Detail</a></p>
+<h3 id="assets"><a href="#assets">Assets</a></h3>
+<table><tbody><tr class="odd">
+<td align="left">See Collections (other than users, groups, and roles)</td>
+</tr></tbody></table><h3 id="collections-other-than-users-groups-and-roles"><a href="#collections-other-than-users-groups-and-roles">Collections (other than users, groups, and roles)</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/{org_id}/{app_id}/</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Retrieve all collections</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#create_entity">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Create a new entity or collection</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#create_entity">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}/<br> {uuid|name}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Retrieve an entity</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#get_entity_uuid">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}/<br> {uuid|name}</p>
+<p>PUT</p>
+<p>application/json</p>
+<p>Update an entity</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#update_entity">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}/<br> {uuid|name}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Delete an entity</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#delete_uuid">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}?{query}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Query a collection</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#query_entity_collection">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}?{query}</p>
+<p>PUT</p>
+<p>application/json</p>
+<p>Update a collection by query</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#update_collection">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}/{entity_id}/<br> {relationship}?{query}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Query an entityâs collections or connections</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#query_entity_collection">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}/<br> {first_entity_id}/{relationship}/<br> {second_entity_id}<br> or<br> /{org_id}/{app_id}/{collection}/<br> {first_entity_id}/{relationship}/<br> {second_entity_type}/{second_entity_id}</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Add an entity to a collection or create a connection</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#put_entity">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}/<br> {first_entity_id}/{relationship}/<br> {second_entity_id}<br> or<br> /{org_id}/{app_id}/{collection}/<br> {first_entity_id}/{relationship}/<br> {second_entity_type}/{second_entity_id}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Remove an entity from a collection or delete a connection</p>
+<p><a href="/docs/usergrid/content/general-purpose-endpoints#remove_entity">Detail</a></p>
+<h3 id="devices"><a href="#devices">Devices</a></h3>
+<table><tbody><tr class="odd">
+<td align="left">See Collections (other than users, groups, and roles)</td>
+</tr></tbody></table><h3 id="events"><a href="#events">Events</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/{org_id}/{app_id}/events</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Create an event</p>
+<p><a href="/docs/usergrid/content/events-and-counters#new_event">Detail</a></p>
+<h3 id="folders"><a href="#folders">Folders</a></h3>
+<table><tbody><tr class="odd">
+<td align="left">See Collections (other than users, groups, and roles)</td>
+</tr></tbody></table><h3 id="groups"><a href="#groups">Groups</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/{org_id}/{app_id}/groups</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Create a new group</p>
+<p><a href="/docs/usergrid/content/group#create_group">Detail</a></p>
+<p>/{org_id}/{app_id}/groups/<br> {uuid|groupname}/users/{uuid|username}</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Add a user to a group</p>
+<p><a href="/docs/usergrid/content/group#add_user_group">Detail</a></p>
+<p>/{org_id}/{app_id}/groups/<br> {uuid|groupname}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get a group</p>
+<p><a href="/docs/usergrid/content/group#get_group">Detail</a></p>
+<p>/{org_id}{app_id}/groups/<br> {uuid|groupname}</p>
+<p>PUT</p>
+<p>application/json</p>
+<p>Update a group</p>
+<p><a href="/docs/usergrid/content/group#update_group">Detail</a></p>
+<p>/{org_id}/{app_id}/groups/<br> {uuid|groupname}/users/{uuid|username}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Delete user from a group</p>
+<p><a href="/docs/usergrid/content/group#delete_user_group">Detail</a></p>
+<p>/{org_id}/{app_id}/groups/<br> {uuid|groupname}/feed</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get a groupâs feed</p>
+<p><a href="/docs/usergrid/content/group#getting-a-group-s-feed">Detail</a></p>
+<h3 id="roles"><a href="#roles">Roles</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/{org_id}/{app_id}/roles</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Create a new role</p>
+<p><a href="/docs/usergrid/content/role#create_role">Detail</a></p>
+<p>/{org_id}/{app_id}/roles</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get the roles in an application</p>
+<p><a href="/docs/usergrid/content/role#get_roles">Detail</a></p>
+<p>/{org_id}/{app_id}/roles/{rolename}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Delete a role</p>
+<p><a href="/docs/usergrid/content/role#delete_role">Detail</a></p>
+<p>/{org_id}/{app_id}/roles/<br> {rolename|role_id}/permissions</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get permissions for a role</p>
+<p><a href="/docs/usergrid/content/role#get_permission">Detail</a></p>
+<p>/{org_id}/{app_id}/roles/<br> {rolename|role_id}/permissions</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Add permissions to a role</p>
+<p><a href="/docs/usergrid/content/role#add_permission">Detail</a></p>
+<p>{org_id}/{app_id}/roles/<br> {rolename|role_id}/permissions?<br> permission={grant_url_pattern}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Delete permissions from a role</p>
+<p><a href="/docs/usergrid/content/role#delete_permission">Detail</a></p>
+<p>/{org_id}/{app_id}/roles/{role_id}/<br> users/{uuid|username}<br> or<br> /{org_id}/{app_id}/users/<br> {uuid|username}/roles/{role_id}</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Add a user to a role</p>
+<p><a href="/docs/usergrid/content/role#adding-a-user-to-a-role">Detail</a></p>
+<p>/{org_id}/{app_id}/roles/{role_id}/<br> users</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get the users in a role</p>
+<p><a href="/docs/usergrid/content/role#getting-the-users-in-a-role">Detail</a></p>
+<p>/{org_id}/{app_id}/roles/{role_id}/<br> users/{uuid|username}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Delete a user from a role</p>
+<p><a href="/docs/usergrid/content/role#deleting-a-user-from-a-role">Detail</a></p>
+<h3 id="users"><a href="#users">Users</a></h3>
+<p>URI</p>
+<p>Verb</p>
+<p>Content Types</p>
+<p>Action</p>
+<p>Â </p>
+<p>/{org_id}/{app_id}/users</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Create a user in the users collection</p>
+<p><a href="/docs/usergrid/content/user#create_user">Detail</a></p>
+<p>/{org_id}/{app_id}/users/{user}/<br> password</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Set a userâs password or reset the userâs existing password</p>
+<p><a href="/docs/usergrid/content/user#set_password">Detail</a></p>
+<p>/{org_id}/{app_id}/users/<br> {uuid|username|email_address}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Retrieve a user</p>
+<p><a href="/docs/usergrid/content/user#uuid">Detail</a></p>
+<p>/{org_id}/{app_id}/users/<br> {uuid|username}</p>
+<p>PUT</p>
+<p>application/json</p>
+<p>Update a user</p>
+<p><a href="/docs/usergrid/content/user#update_user">Detail</a></p>
+<p>/{org_id}/{app_id}/users/{uuid|username}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Delete a user</p>
+<p><a href="/docs/usergrid/content/user#delete_user">Detail</a></p>
+<p>/{org_id}/{app_id}/users?{query}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Query to get users</p>
+<p><a href="/docs/usergrid/content/user#query_get">Detail</a></p>
+<p>/{org_id}/{app_id}/groups/<br> {uuid|groupname}/users/{uuid|username}</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Add a user to a group</p>
+<p><a href="/docs/usergrid/content/user#add_user_group">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}/<br> {first_entity_id}/{relationship}/<br> {second_entity_id}<br> or<br> /{org_id}/{app_id}/{collection}/<br> {first_entity_id}/{relationship}/<br> {second_entity_type}/{second_entity_id}</p>
+<p>POST</p>
+<p>application/json</p>
+<p>Add a user to a collection or create a connection</p>
+<p><a href="/docs/usergrid/content/user#add_collection">Detail</a></p>
+<p>/{org_id}/{app_id}/{collection}/<br> {first_entity_id}/{relationship}/<br> {second_entity_id}<br> or<br> /{org_id}/{app_id}/{collection}/<br> {first_entity_id}/{relationship}/<br> {second_entity_type}/{second_entity_id}</p>
+<p>DELETE</p>
+<p>application/json</p>
+<p>Remove a user from a collection or delete a connection</p>
+<p><a href="/docs/usergrid/content/user#delete_collection">Detail</a></p>
+<p>/{org_id}/{app_id}/users/{uuid|username}/<br> {relationship}?{query}</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Query a userâs collections or connections</p>
+<p><a href="/docs/usergrid/content/user#query_collection">Detail</a></p>
+<p>/{org_id}/{app_id}/users/<br> {uuid|username}/feed</p>
+<p>GET</p>
+<p>application/json</p>
+<p>Get a userâs feed</p>
+<p><a href="/docs/usergrid/content/user#getting-a-user-s-feed">Detail</a></p>
+<h3 id="notifications-notifiers-and-receipts"><a href="#notifications-notifiers-and-receipts">Notifications, Notifiers, and Receipts</a></h3>
+<table><tbody><tr class="odd">
+<td align="left">See <a href="/create-manage-notifications">Create & Manage Notifications</a>
+</td>
+</tr></tbody></table><p>Â </p>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-3"></div>
+ <div class="col-md-9">
+ <div class="github-callout">
+ <strong>Questions?</strong> Please do <a href="https://groups.google.com/forum/#!forum/usergrid">ask on the mailing-list</a>!<br/>
+ <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/rest-endpoints/">this article on github</a>.</div>
+ </div>
+ </div>
+</div>
+
+
+<footer class="bf-footer" role="contentinfo">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="/">Home</a></li>
+ <li class="nav-header"><a href="/community/">Community</a></li>
+ <!-- <li><a href="/community#events">Events</a></li> -->
+ <li><a href="/community/#mailing-lists">Mailing Lists</a></li>
+ <li><a href="/community/#deployments">Deployments</a></li>
+ <li><a href="/community/#committers">Commiters</a></li>
+ <!-- <li class="nav-header"><a href="#">Docs</a></li> -->
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="https://github.com/usergrid/usergrid/" target="_blank">Code</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet" target="_blank">.NET / Windows SDK</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header">Resources</li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank">GitHub Code</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank">JIRA Bug Tracker</a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4">IRC</a></li>
+ <li><a href="https://twitter.com/usergrid" target="_blank">Twitter</a></li>
+ <li><a href="http://incubator.apache.org/projects/usergrid.html" target="_blank">Podling Listing</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/LICENSE" target="_blank">License</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#contributing" target="_blank">Contribution Guidelines</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2"></div>
+ <div class="col-md-4">
+ <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid" data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a>
+ <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ </div>
+ <!--
+ <div class="col-md-4">
+ <div class="input-group form-search">
+ <input type="text" class="form-control search-query">
+ <span class="input-group-btn">
+ <button type="submit" class="btn btn-primary" data-type="last">Search</button>
+ </span>
+ </div>
+ </div> -->
+ </div>
+ <div class="row">
+ <div id="copyright">
+ <img src="/img/egg-logo.png" /><br/><br/>
+ <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
+ <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br>
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p>
+ <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee">@ryuneeee</a> + <a href="https://github.com/realbeast">@realbeast</a> + <a href="https://twitter.com/timanglade">@timanglade</a>.</p>
+ </div>
+ </div>
+ </div>
+</footer>
+
+<script type="text/javascript" src="/js/head.js"></script>
+<script type="text/javascript">
+ head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js");
+</script>
+<script type="text/javascript">
+ //IE outdate friendly warning if you don't want remove it
+ var $buoop = {vs:{i:8,f:3.6,o:10.6,s:3.2,n:9}}
+ $buoop.ol = window.onload;
+ window.onload=function(){
+ try {if ($buoop.ol) $buoop.ol();}catch (e) {}
+ var e = document.createElement("script");
+ e.setAttribute("type", "text/javascript");
+ e.setAttribute("src", "http://browser-update.org/update.js");
+ document.body.appendChild(e);
+ }
+</script>
+
+
+</body>
+</html>
\ No newline at end of file