You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by su...@apache.org on 2014/10/22 18:47:14 UTC
svn commit: r1633650 [10/14] - in
/incubator/usergrid/site/publish/documents: ./ _sources/ _sources/concepts/
_sources/presentations-and-videos/ _static/ _static/css/ _static/fonts/
_static/js/ concepts/ presentations-and-videos/
Added: incubator/usergrid/site/publish/documents/concepts/applications.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/documents/concepts/applications.html?rev=1633650&view=auto
==============================================================================
--- incubator/usergrid/site/publish/documents/concepts/applications.html (added)
+++ incubator/usergrid/site/publish/documents/concepts/applications.html Wed Oct 22 16:47:12 2014
@@ -0,0 +1,407 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Applications — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="up" title="Organizations & Admins" href="../organizations-admins.html"/>
+ <link rel="next" title="Events and counters" href="events-and-counters.html"/>
+ <link rel="prev" title="Organizations & Admins" href="../organizations-admins.html"/>
+
+
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+ <a href="../index.html" class="fa fa-home"> Apache Usergrid</a>
+
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../deploy-local.html">Deploying to local Tomcat & Cassandra</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#example-usergrid-deployment-properties-file">Example usergrid-deployment.properties file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-up-and-running-locally.html">Getting Up & Running Locally</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="reference internal" href="../organizations-admins.html">Organizations & Admins</a><ul class="current">
+<li class="toctree-l2 current"><a class="current reference internal" href="">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="events-and-counters.html">Events and counters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="roles-and-permissions.html">Roles & Permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="relationships.html">Relationships</a></li>
+<li class="toctree-l2"><a class="reference internal" href="collections.html">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="query-language.html">Query Language</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users-devices.html">Users & Devices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="groups.html">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets.html">Assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../presentations-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/presentations.html">Presentations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/videos.html">Videos</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading from Previous Versions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li><a href="../organizations-admins.html">Organizations & Admins</a> »</li>
+
+ <li>Applications</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/concepts/applications.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document">
+
+ <div class="section" id="applications">
+<h1>Applications<a class="headerlink" href="#applications" title="Permalink to this headline">¶</a></h1>
+<p>You can create a new application in an organization through the <a class="reference external" href="/admin-portal">Admin
+portal</a>. The Admin portal creates the new application
+by issuing a post against the management endpoint (see the “Creating an
+organization application” section in <a class="reference external" href="/organization">Organization</a>
+for details). If you need to create an application programmatically in
+your app, you can also use the API to do this. You can access
+application entities using your app name or UUID, prefixed with the
+organization name or UUID:</p>
+<p><a class="reference external" href="http://api.usergrid.com/">https://api.usergrid.com</a>/{org_name|uuid}/{app_name|uuid}</p>
+<p>Most mobile apps never access the application entity directly. For
+example you might have a server-side web app that accesses the
+application entity for configuration purposes. If you want to access
+your application entity programmatically, you can use the API.</p>
+<div class="section" id="application-properties">
+<h2>Application properties<a class="headerlink" href="#application-properties" title="Permalink to this headline">¶</a></h2>
+<p>The following are the system-defined properties for application
+entities. You can create application-specific properties for an
+application entity in addition to the system-defined properties. The
+system-defined properties are reserved. You cannot use these names to
+create other properties for an application entity. In addition the
+applications name is reserved for the applications collection â you
+can’t use it to name another collection.</p>
+<p>The look-up properties for the entities of type application are uuid and
+name, that is, you can use the uuid and name properties to reference an
+application entity in an API call. However, you can search on a role
+using any property of the application entity. See <a class="reference external" href="/queries-and-parameters">Queries and
+parameters</a> for details on searching.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="8%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Property</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>uuid</td>
+<td>UUID</td>
+<td>Applicationâs unique entity ID</td>
+</tr>
+<tr class="row-odd"><td>type</td>
+<td>string</td>
+<td>“application”</td>
+</tr>
+<tr class="row-even"><td>created</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity creation</td>
+</tr>
+<tr class="row-odd"><td>modified</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity modification</td>
+</tr>
+<tr class="row-even"><td>name</td>
+<td>string</td>
+<td>Application name (mandatory)</td>
+</tr>
+<tr class="row-odd"><td>title</td>
+<td>string</td>
+<td>Application title</td>
+</tr>
+<tr class="row-even"><td>description</td>
+<td>string</td>
+<td>Application description</td>
+</tr>
+<tr class="row-odd"><td>activated</td>
+<td>boolean</td>
+<td>Whether application is activated</td>
+</tr>
+<tr class="row-even"><td>disabled</td>
+<td>boolean</td>
+<td>Whether application is administratively disabled</td>
+</tr>
+<tr class="row-odd"><td>allowOpenRegistration</td>
+<td>boolean</td>
+<td>Whether application allows any user to register</td>
+</tr>
+<tr class="row-even"><td>registrationRequiresEmailConfirmation</td>
+<td>boolean</td>
+<td>Whether registration requires email confirmation</td>
+</tr>
+<tr class="row-odd"><td>registrationRequiresAdminApproval</td>
+<td>boolean</td>
+<td>Whether registration requires admin approval</td>
+</tr>
+<tr class="row-even"><td>accesstokenttl</td>
+<td>long</td>
+<td>Time to live value for an access token obtained within the application</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="set-properties">
+<h2>Set properties<a class="headerlink" href="#set-properties" title="Permalink to this headline">¶</a></h2>
+<p>The set properties for applications are listed in the table below.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="12%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Set</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>collections</td>
+<td>string</td>
+<td>Set of collections</td>
+</tr>
+<tr class="row-odd"><td>rolenames</td>
+<td>string</td>
+<td>Set of roles assigned to an application</td>
+</tr>
+<tr class="row-even"><td>counters</td>
+<td>string</td>
+<td>Set of counters assigned to an application</td>
+</tr>
+<tr class="row-odd"><td>oauthproviders</td>
+<td>string</td>
+<td>Set of OAuth providers for the application</td>
+</tr>
+<tr class="row-even"><td>credentials</td>
+<td>string</td>
+<td>Set of credentials required to run the application</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="collections">
+<h2>Collections<a class="headerlink" href="#collections" title="Permalink to this headline">¶</a></h2>
+<p>The collections for applications are listed in the table below.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="14%" />
+<col width="72%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Collection</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>users</td>
+<td>user</td>
+<td>Collection of users</td>
+</tr>
+<tr class="row-odd"><td>groups</td>
+<td>group</td>
+<td>Collection of groups</td>
+</tr>
+<tr class="row-even"><td>folders</td>
+<td>folder</td>
+<td>Collection of assets that represent folder-like objects</td>
+</tr>
+<tr class="row-odd"><td>events</td>
+<td>event</td>
+<td>Collection of events posted by the application</td>
+</tr>
+<tr class="row-even"><td>assets</td>
+<td>asset</td>
+<td>Collection of assets that represent file-like objects</td>
+</tr>
+<tr class="row-odd"><td>activities</td>
+<td>activity</td>
+<td>Collection of activity stream actions</td>
+</tr>
+<tr class="row-even"><td>devices</td>
+<td>device</td>
+<td>Collection of devices in the service</td>
+</tr>
+<tr class="row-odd"><td>notifiers</td>
+<td>notifier</td>
+<td>Collection of notifiers used for push notifications</td>
+</tr>
+<tr class="row-even"><td>notifications</td>
+<td>notification</td>
+<td>Collection of push notifications that have been sent or are scheduled to be sent</td>
+</tr>
+<tr class="row-odd"><td>receipts</td>
+<td>receipt</td>
+<td>Collection of receipts from push notifications that were sent</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="events-and-counters.html" class="btn btn-neutral float-right" title="Events and counters">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../organizations-admins.html" class="btn btn-neutral" title="Organizations & Admins"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2014, Apache Usergrid.
+ </p>
+ </div>
+
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/documents/concepts/assets.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/documents/concepts/assets.html?rev=1633650&view=auto
==============================================================================
--- incubator/usergrid/site/publish/documents/concepts/assets.html (added)
+++ incubator/usergrid/site/publish/documents/concepts/assets.html Wed Oct 22 16:47:12 2014
@@ -0,0 +1,265 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Assets — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="up" title="Organizations & Admins" href="../organizations-admins.html"/>
+ <link rel="next" title="Presentations & Videos" href="../presentations-and-videos.html"/>
+ <link rel="prev" title="Activity" href="activity.html"/>
+
+
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+ <a href="../index.html" class="fa fa-home"> Apache Usergrid</a>
+
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../deploy-local.html">Deploying to local Tomcat & Cassandra</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#example-usergrid-deployment-properties-file">Example usergrid-deployment.properties file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-up-and-running-locally.html">Getting Up & Running Locally</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="reference internal" href="../organizations-admins.html">Organizations & Admins</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="applications.html">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="events-and-counters.html">Events and counters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="roles-and-permissions.html">Roles & Permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="relationships.html">Relationships</a></li>
+<li class="toctree-l2"><a class="reference internal" href="collections.html">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="query-language.html">Query Language</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users-devices.html">Users & Devices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="groups.html">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../presentations-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/presentations.html">Presentations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/videos.html">Videos</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading from Previous Versions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li><a href="../organizations-admins.html">Organizations & Admins</a> »</li>
+
+ <li>Assets</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/concepts/assets.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document">
+
+ <div class="section" id="assets">
+<h1>Assets<a class="headerlink" href="#assets" title="Permalink to this headline">¶</a></h1>
+<p>Asset entities are used primarily in Apache Usergrid to manage binary
+data objects such as images, video, and audio content. However, an asset
+does not have to be used for a binary object. For example, assets can be
+used to model a file system.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="9%" />
+<col width="77%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Property</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>uuid</td>
+<td>UUID</td>
+<td>Assetâs unique entity ID</td>
+</tr>
+<tr class="row-odd"><td>type</td>
+<td>string</td>
+<td>“asset”</td>
+</tr>
+<tr class="row-even"><td>name</td>
+<td>string</td>
+<td>Asset name (mandatory)</td>
+</tr>
+<tr class="row-odd"><td>created</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity creation</td>
+</tr>
+<tr class="row-even"><td>modified</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity modification</td>
+</tr>
+<tr class="row-odd"><td>owner</td>
+<td>UUID</td>
+<td>UUID of the assetâs owner (mandatory)</td>
+</tr>
+<tr class="row-even"><td>path</td>
+<td>string</td>
+<td>Relative path to the asset (mandatory)</td>
+</tr>
+<tr class="row-odd"><td>content-type</td>
+<td>string</td>
+<td>Content type of the asset (for example, âimage/jpegâ)</td>
+</tr>
+</tbody>
+</table>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../presentations-and-videos.html" class="btn btn-neutral float-right" title="Presentations & Videos">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="activity.html" class="btn btn-neutral" title="Activity"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2014, Apache Usergrid.
+ </p>
+ </div>
+
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/documents/concepts/collections.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/documents/concepts/collections.html?rev=1633650&view=auto
==============================================================================
--- incubator/usergrid/site/publish/documents/concepts/collections.html (added)
+++ incubator/usergrid/site/publish/documents/concepts/collections.html Wed Oct 22 16:47:12 2014
@@ -0,0 +1,235 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Collections — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="up" title="Organizations & Admins" href="../organizations-admins.html"/>
+ <link rel="next" title="Query Language" href="query-language.html"/>
+ <link rel="prev" title="Relationships" href="relationships.html"/>
+
+
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+ <a href="../index.html" class="fa fa-home"> Apache Usergrid</a>
+
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../deploy-local.html">Deploying to local Tomcat & Cassandra</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#example-usergrid-deployment-properties-file">Example usergrid-deployment.properties file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-up-and-running-locally.html">Getting Up & Running Locally</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="reference internal" href="../organizations-admins.html">Organizations & Admins</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="applications.html">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="events-and-counters.html">Events and counters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="roles-and-permissions.html">Roles & Permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="relationships.html">Relationships</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="query-language.html">Query Language</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users-devices.html">Users & Devices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="groups.html">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets.html">Assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../presentations-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/presentations.html">Presentations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/videos.html">Videos</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading from Previous Versions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li><a href="../organizations-admins.html">Organizations & Admins</a> »</li>
+
+ <li>Collections</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/concepts/collections.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document">
+
+ <div class="section" id="collections">
+<h1>Collections<a class="headerlink" href="#collections" title="Permalink to this headline">¶</a></h1>
+<p>In Apache Usergrid, all entities are automatically associated with a
+corresponding collection based on the <code class="docutils literal"><span class="pre">type</span></code> property of the entity.
+You may create empty collections if you wish, but creating an entity of
+a new type will automatically create a corresponding collection for you.
+For example, creating a new custom “item” entity, creates an “items”
+collection.</p>
+<p>Queries are always limited in scope to the current collection. That
+should be your primary consideration for data modeling in Apache
+Usergrid.</p>
+<p>The following collections are reserved in the system</p>
+<ul class="simple">
+<li>users</li>
+<li>groups</li>
+<li>activities</li>
+<li>devices</li>
+<li>assets</li>
+<li>folders</li>
+<li>queues</li>
+<li>events</li>
+<li>counters</li>
+</ul>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="query-language.html" class="btn btn-neutral float-right" title="Query Language">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="relationships.html" class="btn btn-neutral" title="Relationships"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2014, Apache Usergrid.
+ </p>
+ </div>
+
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/documents/concepts/events-and-counters.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/documents/concepts/events-and-counters.html?rev=1633650&view=auto
==============================================================================
--- incubator/usergrid/site/publish/documents/concepts/events-and-counters.html (added)
+++ incubator/usergrid/site/publish/documents/concepts/events-and-counters.html Wed Oct 22 16:47:12 2014
@@ -0,0 +1,536 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Events and counters — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="up" title="Organizations & Admins" href="../organizations-admins.html"/>
+ <link rel="next" title="Roles & Permissions" href="roles-and-permissions.html"/>
+ <link rel="prev" title="Applications" href="applications.html"/>
+
+
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+ <a href="../index.html" class="fa fa-home"> Apache Usergrid</a>
+
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../deploy-local.html">Deploying to local Tomcat & Cassandra</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#example-usergrid-deployment-properties-file">Example usergrid-deployment.properties file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-up-and-running-locally.html">Getting Up & Running Locally</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="reference internal" href="../organizations-admins.html">Organizations & Admins</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="applications.html">Applications</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Events and counters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="roles-and-permissions.html">Roles & Permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="relationships.html">Relationships</a></li>
+<li class="toctree-l2"><a class="reference internal" href="collections.html">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="query-language.html">Query Language</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users-devices.html">Users & Devices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="groups.html">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets.html">Assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../presentations-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/presentations.html">Presentations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/videos.html">Videos</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading from Previous Versions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li><a href="../organizations-admins.html">Organizations & Admins</a> »</li>
+
+ <li>Events and counters</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/concepts/events-and-counters.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document">
+
+ <div class="section" id="events-and-counters">
+<h1>Events and counters<a class="headerlink" href="#events-and-counters" title="Permalink to this headline">¶</a></h1>
+<p>Events are typically used for application logging. For example, they
+could be used to log error messages that a system administrator might
+review at a later time. The event mechanism is optimized to handle large
+numbers of events, so it is an ideal mechanism for logging in your
+application.</p>
+<p>You can link events to specific users, groups, or custom-defined
+categories. When created with these links, events offer a powerful tool
+for running highly targeted, custom reports.</p>
+<p>Events are also the primary way to store custom counter data for
+analytics. See Counters (below) for further details.</p>
+<div class="section" id="event-properties">
+<h2>Event properties<a class="headerlink" href="#event-properties" title="Permalink to this headline">¶</a></h2>
+<p>You can pass various system-defined properties for an event. For
+example, you can specify a user property, with a uuid as its value. This
+will link the event to the user and can be used to query against the
+events queue (see Categorization below). The same is true for the group
+property. Pass it with a uuid as the value and the event will be linked
+to the group. To include a uuid of a user or group, add the uuid to the
+request body, for example:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/events {"timestamp":0, "category" : "advertising", "counters" :Â Â {"ad_clicks" : 5},"user" : "1234891-477d-11e1-b2bd-22005a1c4e22", "group" : "75577d891-347d-2231-b5bd-23400a1c4e22"}
+</pre></div>
+</div>
+<p>The response body would look something like this:</p>
+<div class="highlight-python"><div class="highlight"><pre>{
+Â "action": "post",
+Â "application": "7fb8d891-477d-11e1-b2bd-22000a1c4e22",
+Â "params": {},
+Â "path": "/events",
+Â "uri": "https://api.usergrid.com/22000a1c4e22-7fb8d891-477d-11e1-b2bd/7fb8d891-477d-11e1-b2bd-22000a1c4e22/events",
+Â "entities": [
+Â Â Â {
+Â Â Â Â Â "uuid": "ce07ea3c-68b5-11e1-a586-9227e40e3559",
+Â Â Â Â Â "user": "1234891-477d-11e1-b2bd-22005a1c4e22",
+Â Â Â Â Â "group": "75577d891-347d-2231-b5bd-23400a1c4e22",
+Â Â Â Â Â "type": "event",
+Â Â Â Â Â "created": 1331166585282,
+Â Â Â Â Â "modified": 1331166585282,
+Â Â Â Â Â "counters": {
+Â Â Â Â Â Â Â "ad_clicks": 5
+Â Â Â Â Â },
+Â Â Â Â Â "metadata": {
+Â Â Â Â Â Â Â "path": "/events/ce07ea3c-68b5-11e1-a586-9227e40e3559"
+Â Â Â Â Â },
+Â Â Â Â Â "timestamp": 1331166585282
+Â Â Â }
+Â ],
+Â "timestamp": 1331166585018,
+Â "duration": 919,
+Â "organization": "my-org",
+Â "applicationName": "my-app"
+}
+</pre></div>
+</div>
+<p>You can also create application-specific event properties in addition to
+these predefined properties. The system-defined properties are reserved.
+You cannot use these names to create other properties for an event
+entity. In addition the events name is reserved for the events
+collection â you can’t use it to name another collection.</p>
+<p>The System-defined properties are as follows:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="8%" />
+<col width="81%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Property</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>uuid</td>
+<td>UUID</td>
+<td>Eventâs unique entity ID</td>
+</tr>
+<tr class="row-odd"><td>type</td>
+<td>String</td>
+<td>“event”</td>
+</tr>
+<tr class="row-even"><td>created</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity creation</td>
+</tr>
+<tr class="row-odd"><td>modified</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity modification</td>
+</tr>
+<tr class="row-even"><td>timestamp</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of application event (mandatory)</td>
+</tr>
+<tr class="row-odd"><td>user</td>
+<td>UUID</td>
+<td>UUID of application user that posted the event</td>
+</tr>
+<tr class="row-even"><td>group</td>
+<td>UUID</td>
+<td>UUID of application group that posted the event</td>
+</tr>
+<tr class="row-odd"><td>category</td>
+<td>string</td>
+<td>Category used for organizing similar events</td>
+</tr>
+<tr class="row-even"><td>counters</td>
+<td>map</td>
+<td>Counter used for tracking number of similar events</td>
+</tr>
+<tr class="row-odd"><td>message</td>
+<td>string</td>
+<td>Message describing event</td>
+</tr>
+</tbody>
+</table>
+<div class="section" id="categorizing-events">
+<h3>Categorizing events<a class="headerlink" href="#categorizing-events" title="Permalink to this headline">¶</a></h3>
+<p>As mentioned previously, you can link an event to a user or a group
+using a standard <a class="reference external" href="/docs/relationships">Relationship</a>. This enables
+you to categorize and qualify event data for use in tracking and
+analysis. For example, linking events to users and groups, enables you
+to track how often people use a feature. Not only can you determine the
+total number of users that used the feature, but also which groups
+contain users that made the most use of the feature. Or, you could
+provide a location with the event, so you could see how often a feature
+was used by people in San Francisco versus Los Angeles.</p>
+</div>
+</div>
+<div class="section" id="counters">
+<h2>Counters<a class="headerlink" href="#counters" title="Permalink to this headline">¶</a></h2>
+<p>User-defined counters are used in conjunction with events to keep
+statistics on many aspects of an application. User-defined counters are
+JSON objects that are added to events when they are posted. The act of
+posting an event increments the counter. Once created, user-defined
+counters can be used to get reports.</p>
+<p><strong>Note:</strong> It may take up to 30 seconds for a counter to be updated.</p>
+<div class="section" id="user-defined-counters">
+<h3>User-Defined Counters<a class="headerlink" href="#user-defined-counters" title="Permalink to this headline">¶</a></h3>
+<p>With Apache Usergrid, you can define your own counters. Some of the
+things that you might track with a user-defined counter are:</p>
+<ul class="simple">
+<li>How many times people click on the help button in your application.</li>
+<li>How many times your game is played each day.</li>
+<li>How many times your banner ads are clicked each day.</li>
+</ul>
+<p>You can choose any name for a user-defined counter. For example, the
+counter for the help button might be named âhelp_buttonâ or
+âhelp_button_clicksâ.</p>
+<p>To create a user-defined counter, you post to the events collection and
+specify the name and increment value of the counter in the request body.
+The increment value is the value that the counter is incremented by for
+each tracked event. An increment value of 1, means that the counter is
+increment by 1 for each tracked event. You could also specify a higher
+increment value, such as 15, which would increment the value by that
+number, or a negative number, which would decrement the value. You can
+also reset the value of the counter, by specifying an increment value of
+0.</p>
+<p>When a counter is incremented by an event, there will be a 20-30 second
+delay between when the event is posted and when the counter is
+incremented.</p>
+<p>As an example, here’s how to create a user-defined counter named
+âbutton_clicksâ with an increment value of 1:</p>
+<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/events {"counters" : {"button_clicks" : 1},"timestamp" : "0"}
+</pre></div>
+</div>
+<p>The response body would look something like this:</p>
+<div class="highlight-python"><div class="highlight"><pre>{
+Â Â Â "action": "post",
+Â Â Â "path": "/events",
+Â Â Â "uri": "http://api.usergrid.com/438a1ca1-cf9b-11e0-bcc1-12313f0204bb/events",
+Â Â Â "entities": [
+Â Â Â Â Â Â Â {
+Â Â Â Â Â Â Â Â Â Â Â "uuid": "39d41c46-d8e4-11e0-bcc1-12313f0204bb",
+Â Â Â Â Â Â Â Â Â Â Â "type": "event",
+Â Â Â Â Â Â Â Â Â Â Â "timestamp": 1315353555546016,
+Â Â Â Â Â Â Â Â Â Â Â "category":"advertising",
+Â Â Â Â Â Â Â Â Â Â Â "counters": {
+Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â "button_clicks": 1
+Â Â Â Â Â Â Â Â Â Â Â },
+Â Â Â Â Â Â Â Â Â Â Â "created": 1315353555546016,
+Â Â Â Â Â Â Â Â Â Â Â "modified": 1315353555546016,
+Â Â Â Â Â Â Â Â Â Â Â "metadata": {
+Â Â Â Â Â Â Â Â Â Â Â "path": "/events/39d41c46-d8e4-11e0-bcc1-12313f0204bb"
+Â Â Â Â Â Â Â Â Â Â Â }
+Â Â Â Â Â Â Â }
+Â Â Â ],
+Â Â Â "timestamp": 1315353555537,
+Â Â Â "duration": 110,
+Â Â Â "organization": "my-org",
+Â Â Â "applicationName": "my-app"
+}
+</pre></div>
+</div>
+</div>
+<div class="section" id="counter-hierarchy">
+<h3>Counter hierarchy<a class="headerlink" href="#counter-hierarchy" title="Permalink to this headline">¶</a></h3>
+<p>Counters are hierarchical in their structure and in the way they are
+incremented. Each level of the hierarchy is separated by the dot â.â
+operator. The hierarchical structure can be useful if you want to store
+or view statistics in a hierarchical way. For example, suppose you want
+to log errors that your app generates. One way to do this, is to fire an
+event every time an error occurs, by creating a counter called âerrorsâ.
+However, you can get more detail by adding additional parameters to the
+counter. Imagine that you want to track errors in a specific module and
+function within that module, say module_1, function_1, you could use a
+counter like this:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">errors</span><span class="o">.</span><span class="n">module_1</span><span class="o">.</span><span class="n">function_1</span>
+</pre></div>
+</div>
+<p>And then for a different function in the same module:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">errors</span><span class="o">.</span><span class="n">module_1</span><span class="o">.</span><span class="n">function_2</span>
+</pre></div>
+</div>
+<p>And then for a different function in a different module:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">errors</span><span class="o">.</span><span class="n">module_2</span><span class="o">.</span><span class="n">function_3</span>
+</pre></div>
+</div>
+<p>If each of the preceding examples were called once, the resulting values
+would be:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">errors</span> <span class="o">=</span> <span class="mi">3</span>
+<span class="n">errors</span><span class="o">.</span><span class="n">module_1</span> <span class="o">=</span> <span class="mi">2</span>
+<span class="n">errors</span><span class="o">.</span><span class="n">module_1</span><span class="o">.</span><span class="n">function_1</span> <span class="o">=</span> <span class="mi">1</span>
+<span class="n">errors</span><span class="o">.</span><span class="n">module_1</span><span class="o">.</span><span class="n">function_2</span> <span class="o">=</span> <span class="mi">1</span>
+<span class="n">errors</span><span class="o">.</span><span class="n">module_2</span> <span class="o">=</span> <span class="mi">1</span>
+<span class="n">errors</span><span class="o">.</span><span class="n">module_2</span><span class="o">.</span><span class="n">function_3</span> <span class="o">=</span> <span class="mi">1</span>
+</pre></div>
+</div>
+<p>This tells you that there were 3 errors in the application, with 2 of
+those errors in module_1. You can then drill down further to see errors
+in specific functions.</p>
+</div>
+<div class="section" id="using-counters-in-time-series-queries">
+<h3>Using counters in time series queries<a class="headerlink" href="#using-counters-in-time-series-queries" title="Permalink to this headline">¶</a></h3>
+<p>Knowing the value of a counter is useful. However, you often need to
+know how the value varies over time. Fortunately, the API provides a
+method for you to view this data over any time interval or level of
+granularity.</p>
+<p>For example, letâs say youâre incrementing a counter every time someone
+launches your application. You might be interested in which days of the
+week the application sees the most usage. Using the API, you can examine
+the counter over a set of weeks, with the data split into daily
+intervals. Using this information, you can see which are your peak days
+of usage. You can also view usage across a single day, so you can see if
+your application is used more in the mornings or the evenings. For
+business reporting, you may be more interested in monthly reporting.</p>
+<p>Note that the system is able to provide you with the report data as you
+need it. The data is maintained in real-time so it can be viewed
+instantly.</p>
+</div>
+<div class="section" id="retrieving-counter-data">
+<h3>Retrieving counter data<a class="headerlink" href="#retrieving-counter-data" title="Permalink to this headline">¶</a></h3>
+<p>To retrieve counter data, you issue a GET request to the /counters
+endpoint. This is a special, built-in collection that gives you access
+to all the counters currently in the system. The API also provides a
+number of parameters that you can use to search for counter data, as
+follows:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="4%" />
+<col width="23%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>start_time</td>
+<td>An <a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">Epoch(Unix)</a> timestamp in milliseconds</td>
+<td>The beginning of the time period to search</td>
+</tr>
+<tr class="row-odd"><td>end_time</td>
+<td>An <a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">Epoch(Unix)</a> timestamp in milliseconds</td>
+<td>The end of the time period to search</td>
+</tr>
+<tr class="row-even"><td>counter</td>
+<td>string</td>
+<td>The name of a specific counter to search. You can specify more than one counter in a query (for example, counter=counter1&counter=counter2...)</td>
+</tr>
+<tr class="row-odd"><td>resolution</td>
+<td>string</td>
+<td>The interval at which counters are displayed. For example, if the interval is day, and the start time and end time values span 4 days, you will get aggregate counts for each of the 4 days. Possible values are all, minute, five_minutes, half_hour, hour, six_day, day, week, and month.</td>
+</tr>
+</tbody>
+</table>
+<p>For example, to retrieve a time range of values, with a granularity of
+“day”, for a counter called “button_clicks”, the GET request would look
+like this:</p>
+<div class="highlight-python"><div class="highlight"><pre>GET /my-org/my-app/counters?start_time=1315119600000&end_time=1315724400000&resolution=day&counter=button_clicks
+</pre></div>
+</div>
+<p>The response body would look something like this:</p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ action: "get",
+ uri: "http://api.usergrid.com/438a1ca1-cf9b-11e0-bcc1-12313f0204bb/counters",
+ timestamp: 1315354369272,
+ duration: 28,
+ counters: [
+ {
+ name: "button_clicks",
+ values: [
+ {
+ value: 2
+ timestamp: 1315180800000
+ },
+ {
+ value: 1
+ timestamp: 1315267200000
+ },
+ {
+ value: 1
+ timestamp: 1315353600000
+ }
+ ]
+ }
+ ]
+}
+</pre></div>
+</div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="roles-and-permissions.html" class="btn btn-neutral float-right" title="Roles & Permissions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="applications.html" class="btn btn-neutral" title="Applications"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2014, Apache Usergrid.
+ </p>
+ </div>
+
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/documents/concepts/groups.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/documents/concepts/groups.html?rev=1633650&view=auto
==============================================================================
--- incubator/usergrid/site/publish/documents/concepts/groups.html (added)
+++ incubator/usergrid/site/publish/documents/concepts/groups.html Wed Oct 22 16:47:12 2014
@@ -0,0 +1,332 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Groups — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="up" title="Organizations & Admins" href="../organizations-admins.html"/>
+ <link rel="next" title="Activity" href="activity.html"/>
+ <link rel="prev" title="Users & Devices" href="users-devices.html"/>
+
+
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+ <a href="../index.html" class="fa fa-home"> Apache Usergrid</a>
+
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+ <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../deploy-local.html">Deploying to local Tomcat & Cassandra</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../deploy-local.html#example-usergrid-deployment-properties-file">Example usergrid-deployment.properties file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-up-and-running-locally.html">Getting Up & Running Locally</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getting-up-and-running-locally.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="reference internal" href="../organizations-admins.html">Organizations & Admins</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="applications.html">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="events-and-counters.html">Events and counters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="roles-and-permissions.html">Roles & Permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="relationships.html">Relationships</a></li>
+<li class="toctree-l2"><a class="reference internal" href="collections.html">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="query-language.html">Query Language</a></li>
+<li class="toctree-l2"><a class="reference internal" href="users-devices.html">Users & Devices</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="activity.html">Activity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="assets.html">Assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../presentations-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/presentations.html">Presentations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../presentations-and-videos/videos.html">Videos</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../upgrading.html">Upgrading from Previous Versions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li><a href="../organizations-admins.html">Organizations & Admins</a> »</li>
+
+ <li>Groups</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/concepts/groups.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document">
+
+ <div class="section" id="groups">
+<h1>Groups<a class="headerlink" href="#groups" title="Permalink to this headline">¶</a></h1>
+<p>You can organize app users into groups. Groups have their own Activity
+Feed, their own permissions and be a useful alternative to Roles,
+depending on how you model your data. Groups were originaly designed to
+emulate Facebook Groups, so they will tend to function about the same
+way Facebook Groups would.</p>
+<p>Groups are hierarchical. Every member of the group
+/groups/california/san-francisco is also a member of the group
+/groups/california.</p>
+<p>Groups are also a great way to model things such a topic subscriptions.
+For example, you could allow people to subscribe (i.e. become a member
+of the group and be alerted via Activities) to /groups/memes/dogs/doge
+or subscribe to all /groups/memes/dogs</p>
+<div class="section" id="general-properties">
+<h2>General properties<a class="headerlink" href="#general-properties" title="Permalink to this headline">¶</a></h2>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="9%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Property</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>uuid</td>
+<td>UUID</td>
+<td>Groupâs unique entity ID</td>
+</tr>
+<tr class="row-odd"><td>type</td>
+<td>string</td>
+<td>Type of entity, in this case âuserâ</td>
+</tr>
+<tr class="row-even"><td>created</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity creation</td>
+</tr>
+<tr class="row-odd"><td>modified</td>
+<td>long</td>
+<td><a class="reference external" href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity modification</td>
+</tr>
+<tr class="row-even"><td>path</td>
+<td>string</td>
+<td>Valid slash-delimited group path (mandatory)</td>
+</tr>
+<tr class="row-odd"><td>title</td>
+<td>string</td>
+<td>Display name</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="set-properties">
+<h2>Set properties<a class="headerlink" href="#set-properties" title="Permalink to this headline">¶</a></h2>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Set</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>connections</td>
+<td>string</td>
+<td>Set of connection types (e.g., likes)</td>
+</tr>
+<tr class="row-odd"><td>rolenames</td>
+<td>string</td>
+<td>Set of roles assigned to a group</td>
+</tr>
+<tr class="row-even"><td>credentials</td>
+<td>string</td>
+<td>Set of group credentials</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="collections">
+<h2>Collections<a class="headerlink" href="#collections" title="Permalink to this headline">¶</a></h2>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Collection</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>users</td>
+<td>user</td>
+<td>Collection of users in the group</td>
+</tr>
+<tr class="row-odd"><td>activities</td>
+<td>activity</td>
+<td>Collection of activities a user has performed</td>
+</tr>
+<tr class="row-even"><td>feed</td>
+<td>activity</td>
+<td>Inbox of activity notifications a group has received</td>
+</tr>
+<tr class="row-odd"><td>roles</td>
+<td>role</td>
+<td>Set of roles to which a group belongs</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="activity.html" class="btn btn-neutral float-right" title="Activity">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="users-devices.html" class="btn btn-neutral" title="Users & Devices"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2014, Apache Usergrid.
+ </p>
+ </div>
+
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file