Google Git
Sign in
apache / usergrid / 28cad0117254552c786717a52fe4921aef6e6ad1 / . / content / docs / assets-and-files / folders.html
blob: 1ca865331a994688c86f090d693768522b273bb3 [file] [log] [blame]
<!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>Folders &mdash; Apache Usergrid 2.x documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="top" title="Apache Usergrid 2.x documentation" href="../index.html"/>
<link rel="next" title="Counters &amp; events" href="../counters-and-events/events-and-counters.html"/>
<link rel="prev" title="Retrieving assets" href="retrieving-assets.html"/>
<script src="../_static/js/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="icon icon-home"> Apache Usergrid
</a>
<div class="version">
2.x
</div>
<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">
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Using Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../using-usergrid/creating-account.html">Creating a Usergrid Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using-usergrid/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using-usergrid/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using-usergrid/using-the-api.html">Using the API</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Storage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Queries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters &amp; clauses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators &amp; data types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
</ul>
<p class="caption"><span class="caption-text">Entity Connections</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Push Notifications</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/overview.html">Push notifications overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/adding-push-support.html">Adding push notifications support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/getting-started.html">Getting started with push notifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/tutorial.html">Tutorial: Push notifications sample app</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/registering.html">Registering with a notification service</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/creating-notifiers.html">Creating notifiers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/managing-users-and-devices.html">Managing users and devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/creating-and-managing-notifications.html">Creating and managing notifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/troubleshooting.html">Troubleshooting</a></li>
</ul>
<p class="caption"><span class="caption-text">Security &amp; Authentication</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security &amp; token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users &amp; app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
</ul>
<p class="caption"><span class="caption-text">User Management &amp; Social Graph</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management &amp; social graph</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
</ul>
<p class="caption"><span class="caption-text">Geo-location</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Assets &amp; Files</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="uploading-assets.html">Uploading assets</a></li>
<li class="toctree-l1"><a class="reference internal" href="retrieving-assets.html">Retrieving assets</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Folders</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#linking-a-folder-to-an-asset">Linking a folder to an asset</a></li>
<li class="toctree-l2"><a class="reference internal" href="#retrieve-list-of-folder-assets">Retrieve list of folder assets</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Counters &amp; Events</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters &amp; events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating &amp; incrementing counters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
</ul>
<p class="caption"><span class="caption-text">Organizations &amp; Applications</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization &amp; application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#sub-types">Sub-Types</a></li>
</ul>
<p class="caption"><span class="caption-text">Client SDKs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
</ul>
<p class="caption"><span class="caption-text">Installing Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/deployment-guide.html">Usergrid 2.1.0 Deployment Guide</a></li>
</ul>
<p class="caption"><span class="caption-text">More about Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations &amp; Videos</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code &amp; Docs</a></li>
</ul>
</div>
&nbsp;
</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> &raquo;</li>
<li>Folders</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/assets-and-files/folders.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="folders">
<h1>Folders<a class="headerlink" href="#folders" title="Permalink to this headline"></a></h1>
<div class="section" id="linking-a-folder-to-an-asset">
<h2>Linking a folder to an asset<a class="headerlink" href="#linking-a-folder-to-an-asset" title="Permalink to this headline"></a></h2>
<p>In order to access the asset for the image in the folder, you need to
link the folder to the asset. You can do that by issuing a POST request
in the following format:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">POST</span> <span class="o">/</span><span class="p">{</span><span class="n">org</span><span class="o">-</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="p">{</span><span class="n">app</span><span class="o">-</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="n">folders</span><span class="o">/</span><span class="p">{</span><span class="n">folder</span><span class="o">-</span><span class="n">uuid</span><span class="p">}</span><span class="o">/</span><span class="n">assets</span><span class="o">/</span><span class="p">{</span><span class="n">assets_id</span><span class="p">}</span>
</pre></div>
</div>
<p>where <code class="docutils literal"><span class="pre">{folder-uuid}</span></code> is the UUID of the folder, and <code class="docutils literal"><span class="pre">{assets-uuid}</span></code>
is the UUID of the assets entity.</p>
<p>Here’s how you could link the folder and the asset you created for the
my-image.jpg image:</p>
<div class="highlight-python"><div class="highlight"><pre>POST https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b
</pre></div>
</div>
<p>In the response, you should see the assets entity for the image added to
the folder:</p>
<div class="highlight-python"><div class="highlight"><pre>{
&quot;action&quot;: &quot;post&quot;,
&quot;application&quot;: &quot;3400ba10-cd0c-11e1-bcf7-12313d1c4491&quot;,
&quot;params&quot;: {},
&quot;path&quot;: &quot;/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets&quot;,
&quot;uri&quot;: &quot;https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets&quot;,
&quot;entities&quot;: [
{
&quot;uuid&quot;: &quot;9501cda1-2d21-11e2-b4c6-02e81ac5a17b&quot;,
&quot;type&quot;: &quot;asset&quot;,
&quot;name&quot;: &quot;my-image.jpg&quot;,
&quot;created&quot;: 1352763303163,
&quot;modified&quot;: 1352763303163,
&quot;metadata&quot;: {
&quot;path&quot;: &quot;/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b&quot;
},
&quot;owner&quot;: &quot;5c0c1789-d503-11e1-b36a-12313b01d5c1&quot;,
&quot;path&quot;: &quot;/myassets/asset1&quot;
}
],
&quot;timestamp&quot;: 1352830448045,
&quot;duration&quot;: 54,
&quot;organization&quot;: &quot;my-org”,
&quot;applicationName&quot;: &quot;my-app&quot;
}
</pre></div>
</div>
</div>
<div class="section" id="retrieve-list-of-folder-assets">
<h2>Retrieve list of folder assets<a class="headerlink" href="#retrieve-list-of-folder-assets" title="Permalink to this headline"></a></h2>
<p>You can also request a list of the linked contents of the folder like
this:</p>
<div class="highlight-python"><div class="highlight"><pre>GET https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets
</pre></div>
</div>
<p>The response should look something like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;action&quot;</span><span class="p">:</span> <span class="s">&quot;get&quot;</span><span class="p">,</span>
<span class="s">&quot;application&quot;</span><span class="p">:</span> <span class="s">&quot;3400ba10-cd0c-11e1-bcf7-12313d1c4491&quot;</span><span class="p">,</span>
<span class="s">&quot;params&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;_&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;1352830364891&quot;</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="s">&quot;path&quot;</span><span class="p">:</span> <span class="s">&quot;/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets&quot;</span><span class="p">,</span>
<span class="s">&quot;uri&quot;</span><span class="p">:</span> <span class="s">&quot;https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets&quot;</span><span class="p">,</span>
<span class="s">&quot;entities&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;uuid&quot;</span><span class="p">:</span> <span class="s">&quot;7bf47435-2ac8-11e2-b4c6-02e81ac5a17b&quot;</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;asset&quot;</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;my-image.jpg&quot;</span><span class="p">,</span>
<span class="s">&quot;created&quot;</span><span class="p">:</span> <span class="mi">1352505133598</span><span class="p">,</span>
<span class="s">&quot;modified&quot;</span><span class="p">:</span> <span class="mi">1352507245108</span><span class="p">,</span>
<span class="s">&quot;checksum&quot;</span><span class="p">:</span> <span class="s">&quot;8e0cd3866ee20746c99e9a9825f38ad8&quot;</span><span class="p">,</span>
<span class="s">&quot;content-length&quot;</span><span class="p">:</span> <span class="mi">11853</span><span class="p">,</span>
<span class="s">&quot;content-type&quot;</span><span class="p">:</span> <span class="s">&quot;image/jpeg&quot;</span><span class="p">,</span>
<span class="s">&quot;etag&quot;</span><span class="p">:</span> <span class="s">&quot;</span><span class="se">\&quot;</span><span class="s">8e0cd3866ee20746c99e9a9825f38ad8</span><span class="se">\&quot;</span><span class="s">&quot;</span><span class="p">,</span>
<span class="s">&quot;metadata&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;connecting&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;assets&quot;</span><span class="p">:</span> <span class="s">&quot;/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b/connecting/assets&quot;</span>
<span class="p">},</span>
<span class="s">&quot;connection&quot;</span><span class="p">:</span> <span class="s">&quot;assets&quot;</span><span class="p">,</span>
<span class="s">&quot;path&quot;</span><span class="p">:</span> <span class="s">&quot;/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b&quot;</span>
<span class="p">},</span>
<span class="s">&quot;owner&quot;</span><span class="p">:</span> <span class="s">&quot;5c0c1789-d503-11e1-b36a-12313b01d5c1&quot;</span><span class="p">,</span>
<span class="s">&quot;path&quot;</span><span class="p">:</span> <span class="s">&quot;my-image&quot;</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s">&quot;timestamp&quot;</span><span class="p">:</span> <span class="mi">1352830363797</span><span class="p">,</span>
<span class="s">&quot;duration&quot;</span><span class="p">:</span> <span class="mi">57</span><span class="p">,</span>
<span class="s">&quot;organization&quot;</span><span class="p">:</span> <span class="s">&quot;my-org&quot;</span><span class="p">,</span>
<span class="s">&quot;applicationName&quot;</span><span class="p">:</span> <span class="s">&quot;my-app&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../counters-and-events/events-and-counters.html" class="btn btn-neutral float-right" title="Counters &amp; events" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="retrieving-assets.html" class="btn btn-neutral" title="Retrieving assets" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2013-2015, 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:'2.x',
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>