You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by ti...@apache.org on 2013/11/18 07:09:27 UTC
svn commit: r1542910 [13/36] - in /incubator/usergrid/site/publish: ./
bootstrap/ bootstrap/bootstrap/ community/ css/ css/bootflat-extensions/
css/bootflat-square/ css/bootflat/ css/font-awesome/ css/usergrid-site/
docs/ docs/access-token/ docs/activi...
Added: incubator/usergrid/site/publish/docs/deleting-data-entities/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/deleting-data-entities/index.html?rev=1542910&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/deleting-data-entities/index.html (added)
+++ incubator/usergrid/site/publish/docs/deleting-data-entities/index.html Mon Nov 18 06:09:23 2013
@@ -0,0 +1,631 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) â Deleting Data Entities</title>
+ <meta http-equiv="x-ua-compatible" content="ie=edge" />
+ <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" />
+ <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service">
+ <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <meta property="og:title" content="Apache Usergrid" />
+ <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <!-- Loading Typekit -->
+ <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script>
+ <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
+ <!-- Loading Bootstrap -->
+ <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'>
+ <link href="/css/bootflat.css" rel="stylesheet" type='text/css'>
+ <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'>
+ <link href="http://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic" rel="stylesheet" type="text/css">
+ <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
+
+
+
+ <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
+ <!--[if lt IE 9]>
+ <script src="js/html5shiv.js"></script>
+ <script src="js/respond.min.js"></script>
+ <![endif]-->
+</head>
+<body>
+
+ <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner">
+ <div class="container">
+ <div class="navbar-header">
+ <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a href="/" class="navbar-brand">
+ <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
+ </a>
+ </div>
+ <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
+ <ul class="nav navbar-nav navbar-right">
+ <!--<li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>-->
+ <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank"><span class="icns icon-github-sign"></span></a></li>
+ <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span class="icns icon-trello"></span></a></li>-->
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank"><span class="icns icon-bug"></span></a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank"><span class="icns icon-stackexchange"></span></a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4" target="_blank"><span class="icns icon-comments"></span></a></li>
+ <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid" target="_blank"><span class="icns icon-envelope"></span></a></li>-->
+ <li><a href="https://twitter.com/usergrid" target="_blank"><span class="icns icon-twitter"></span></a></li>
+ </ul>
+ </nav>
+ </div>
+ </header>
+
+
+<div class="container bf-docs-container">
+ <div class="row">
+ <div class="col-md-3">
+ <div class="bf-sidebar hidden-print" role="complementary">
+ <ul class="nav nav-list">
+ <li><a href="#">Getting Up & Running Locally</a></li>
+ <li><a href="#"><code>ugc</code> â the Command-line Client</a></li>
+
+ <li class="nav-header"><span>Concepts</span></li>
+ <li>
+ <a href="/docs/organizations-admins/">Organizations & Admins</a>
+ <ul>
+ <li>
+ <a href="/docs/applications">Applications</a>
+ <ul>
+ <li><a href="#">Roles & Permissions</a></li>
+ <li><a href="#">Queues</a></li>
+ <li><a href="#">Events & Counters</a></li>
+ <li>
+ <a href="#">Collections</a>
+ <ul>
+ <li><a href="#">Query Language</a></li>
+ <li><a href="#">Users & Devices</a></li>
+ <li><a href="#">Groups</a></li>
+ <li><a href="#">Activities</a></li>
+ <li><a href="#">Assets</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-header"><span>Usage</span></li>
+ <li><a href="/docs/rest-api">REST API</a></li>
+ <li><a class="icns-apple" href="#">iOS SDK</a></li>
+ <li><a class="icns-android" href="#">Android SDK</a></li>
+ <li><a class="icns-html5" href="/docs/html5-javascript-sdk">HTML5 / JavaScript SDK</a></li>
+ <li><a class="icns-windows" href="#">Windows 8 / Windows Phone / .net SDK</a></li>
+ <li><a href="/docs/nodejs-module">Node.js module</a></li>
+ <li><a href="/docs/ruby-gem">Ruby gem</a></li>
+ <li><a href="#">Ruby on Rails gem</a></li>
+ <li><a href="#">PHP library</a></li>
+
+ <li class="nav-header"><span>Internals</span></li>
+ <li><a href="#">Design & Goals</a></li>
+ <li><a href="#">Java Architecture</a></li>
+ <li><a href="#">Cassandra Schema</a></li>
+ <li><a href="#">Contributing</a></li>
+
+ <li class="nav-header"><span>Operations</span></li>
+ <li><a href="#">Deploying</a></li>
+ <li><a href="#">Monitoring</a></li>
+ <li><a href="#">Upgrading</a></li>
+ <li><a href="#">Security</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div class="col-md-9 main-article" role="main">
+ <div class="page-article">
+ <div class="page-header">
+ <h1>Deleting Data Entities</h1>
+ <small><a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/deleting-data-entities/">contribute to this article on github</a></small>
+ </div>
+ <div class="toc">
+ <ul>
+<li>
+<a href="#deleting-data-entities">Deleting Data Entities</a><ul>
+<li>
+<a href="#deleting-an-entity">Deleting an entity</a><ul>
+<li><a href="#example-requestresponse">Example Request/Response</a></li>
+<li><a href="#request-syntax">Request Syntax</a></li>
+<li><a href="#parameters">Parameters</a></li>
+<li><a href="#example-requestresponse-1">Example Request/Response</a></li>
+<li><a href="#sdk-method">SDK Method</a></li>
+<li><a href="#properties">Properties</a></li>
+<li><a href="#example-requestresponse-2">Example Request/Response</a></li>
+<li><a href="#sdk-method-1">SDK Method</a></li>
+<li><a href="#properties-1">Properties</a></li>
+<li><a href="#example-requestresponse-3">Example Request/Response</a></li>
+<li><a href="#sdk-method-2">SDK Method</a></li>
+<li><a href="#parameters-1">Parameters</a></li>
+<li><a href="#example-requestresponse-4">Example Request/Response</a></li>
+<li><a href="#sdk-method-3">SDK Method</a></li>
+<li><a href="#example-requestresponse-5">Example Request/Response</a></li>
+<li><a href="#sdk-method-4">SDK Method</a></li>
+<li><a href="#parameters-2">Parameters</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<h1 id="deleting-data-entities"><a href="#deleting-data-entities">Deleting Data Entities</a></h1>
+<p>This article describes how to delete data entities.</p>
+<p><strong>Note:</strong>Although not shown in the API examples below, you need to provide a valid access token with each API call. See <a href="/authenticating-users-and-application-clients">Authenticating users and application clients</a> for details.</p>
+<h2 id="deleting-an-entity"><a href="#deleting-an-entity">Deleting an entity</a></h2>
+<ul>
+<li><a href="#curl_delete_entity">cURL</a></li>
+<li><a href="#ios_delete_entity">iOS</a></li>
+<li><a href="#android_delete_entity">Android</a></li>
+<li><a href="#javascript_delete_entity">JavaScript (HTML5)</a></li>
+<li><a href="#ruby_delete_entity">Ruby</a></li>
+<li><a href="#nodejs_delete_entity">Node.js</a></li>
+</ul><h3 id="example-requestresponse"><a href="#example-requestresponse">Example Request/Response</a></h3>
+<h4 id="request"><a href="#request">Request:</a></h4>
+<p>Delete by UUID:</p>
+<pre><code>curl -X DELETE "https://api.usergrid.com/your-org/your-app/items/da4a50dc-38dc-11e2-b2e4-02e81adcf3d0"</code></pre>
+<p>Delete by ânameâ property:</p>
+<pre><code>curl -X DELETE "https://api.usergrid.com/your-org/your-app/items/milk"</code></pre>
+<h4 id="response"><a href="#response">Response:</a></h4>
+<pre><code>{
+ "action" : "delete",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378766158500,
+ "modified" : 1378766158500,
+ "metadata" : {
+ "path" : "/items/328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1378766172016,
+ "duration" : 324,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}</code></pre>
+<h3 id="request-syntax"><a href="#request-syntax">Request Syntax</a></h3>
+<pre><code>curl -X DELETE https://api.usergrid.com/<org>/<app>/<collection>/<entity></code></pre>
+<h3 id="parameters"><a href="#parameters">Parameters</a></h3>
+<table>
+<thead><tr class="header">
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">org</td>
+<td align="left">Organization UUID or organization name</td>
+</tr>
+<tr class="even">
+<td align="left">app</td>
+<td align="left">Application UUID or application name</td>
+</tr>
+<tr class="odd">
+<td align="left">collection</td>
+<td align="left">Collection UUID or collection name</td>
+</tr>
+<tr class="even">
+<td align="left">entity</td>
+<td align="left">Entity UUID or entity name</td>
+</tr>
+</tbody>
+</table><p>This example uses the <a href="/app-services-sdks#ios">Apache Usergrid iOS SDK</a>.</p>
+<h3 id="example-requestresponse-1"><a href="#example-requestresponse-1">Example Request/Response</a></h3>
+<h4 id="request-1"><a href="#request-1">Request:</a></h4>
+<pre><code>-(NSString*)deleteEntity {
+
+ //specify the entity type to be deleted
+ NSString *type = @"item";
+
+ //specify the uuid or name of the entity to be deleted
+ NSString *entityId = @"milk";
+
+ //we recommend you call ApigeeClient from your AppDelegate.
+ //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios
+ //create an instance of AppDelegate
+ AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate];
+
+ //call createEntity to initiate the API call
+ ApigeeClientResponse *response = [appDelegate.dataClient removeEntity:type entityID:entityId];
+
+ @try {
+ //success
+ }
+ @catch (NSException * e) {
+ //fail
+ }
+
+}
+
+ </code></pre>
+<h4 id="response-1"><a href="#response-1">Response:</a></h4>
+<pre><code>{
+ "action" : "delete",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378766158500,
+ "modified" : 1378766158500,
+ "metadata" : {
+ "path" : "/items/328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1378766172016,
+ "duration" : 324,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}</code></pre>
+<h3 id="sdk-method"><a href="#sdk-method">SDK Method</a></h3>
+<pre><code>(ApigeeClientResponse *)removeEntity: (NSString *)type entityID:(NSString *)entityID</code></pre>
+<h3 id="properties"><a href="#properties">Properties</a></h3>
+<table>
+<thead><tr class="header">
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">type</td>
+<td align="left">The entity type being deleted</td>
+</tr>
+<tr class="even">
+<td align="left">entityID</td>
+<td align="left">The UUID or name of the entity to be removed</td>
+</tr>
+</tbody>
+</table><p>This example uses the <a href="/app-services-sdks#android">Apache Usergrid Android SDK</a>.</p>
+<h3 id="example-requestresponse-2"><a href="#example-requestresponse-2">Example Request/Response</a></h3>
+<h4 id="request-2"><a href="#request-2">Request:</a></h4>
+<pre><code>//Create client entity
+String ORGNAME = "your-org";
+String APPNAME = "your-app";
+ApigeeClient apigeeClient = new ApigeeClient(ORGNAME,APPNAME);
+DataClient dataClient = apigeeClient.getDataClient();
+
+String type = "item"; //entity type to be retrieved
+String uuid = "b3aad0a4-f322-11e2-a9c1-999e12039f87";
+
+//call removeEntityAsync to initiate the asynchronous API call
+dataClient.removeEntityAsync(type, uuid, new ApiResponseCallback() {
+
+//If removeEntityAsync fails, catch the error
+@Override
+public void onException(Exception e) {
+ // Error
+}
+
+//If removeEntityAsync is successful, handle the response object
+@Override
+public void onResponse(ApiResponse response) {
+ try {
+ if (response != null) {
+ // Success
+ }
+ } catch (Exception e) { //The API request returned an error
+ // Fail
+ }
+}
+});
+ </code></pre>
+<h4 id="response-2"><a href="#response-2">Response:</a></h4>
+<pre><code>{"action":"delete","application":"f34f4222-a166-11e2-a7f7-02e81adcf3d0","entities":[{"dataClient":{"accessToken":null,"apiUrl":"https://api.usergrid.com","applicationId":"your-app","clientId":null,"clientSecret":null,"currentOrganization":null,"loggedInUser":null,"organizationId":"your-org"},"type":"item","uuid":"d1511d7a-19a1-11e3-b02b-cd5b309a29fa","created":1378766854343,"name":"milk","modified":1378766854343,"metadata":{"path":"/items/d1511d7a-19a1-11e3-b02b-cd5b309a29fa"}}],"params":{},"path":"/items","rawResponse":"{
+ "action" : "delete",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "d1511d7a-19a1-11e3-b02b-cd5b309a29fa",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378766854343,
+ "modified" : 1378766854343,
+ "metadata" : {
+ "path" : "/items/d1511d7a-19a1-11e3-b02b-cd5b309a29fa"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1378767852615,
+ "duration" : 276,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}
+","uri":"http://api.usergrid.com/your-org/your-app/items","timestamp":1378767852615,"entityCount":1,"firstEntity":{"dataClient":{"accessToken":null,"apiUrl":"https://api.usergrid.com","applicationId":"your-app","clientId":null,"clientSecret":null,"currentOrganization":null,"loggedInUser":null,"organizationId":"your-org"},"type":"item","uuid":"d1511d7a-19a1-11e3-b02b-cd5b309a29fa","created":1378766854343,"name":"milk","modified":1378766854343,"metadata":{"path":"/items/d1511d7a-19a1-11e3-b02b-cd5b309a29fa"}},"lastEntity":{"dataClient":{"accessToken":null,"apiUrl":"https://api.usergrid.com","applicationId":"your-app","clientId":null,"clientSecret":null,"currentOrganization":null,"loggedInUser":null,"organizationId":"your-org"},"type":"item","uuid":"d1511d7a-19a1-11e3-b02b-cd5b309a29fa","created":1378766854343,"name":"milk","price" : "3.25","modified":1378766854343,"metadata":{"path":"/items/d1511d7a-19a1-11e3-b02b-cd5b309a29fa"}},"organization":"your-org","duration":276,"applicationNa
me":"your-app"}
+ </code></pre>
+<h3 id="sdk-method-1"><a href="#sdk-method-1">SDK Method</a></h3>
+<pre><code>removeEntity(String entityType, String entityID)</code></pre>
+<h3 id="properties-1"><a href="#properties-1">Properties</a></h3>
+<table>
+<thead><tr class="header">
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">entityType</td>
+<td align="left">The entity type of the entity to be deleted</td>
+</tr>
+<tr class="even">
+<td align="left">entityID</td>
+<td align="left">The UUID or name of the entity to be deleted</td>
+</tr>
+</tbody>
+</table><p>This example uses the <a href="/app-services-sdks#javascript">Apache Usergrid JavaScript (HTML5) SDK</a>.</p>
+<h3 id="example-requestresponse-3"><a href="#example-requestresponse-3">Example Request/Response</a></h3>
+<h4 id="request-3"><a href="#request-3">Request:</a></h4>
+<pre><code>//create the basic client object
+var dataClient = new Usergrid.Client({
+ orgName:'your-org',
+ appName:'your-app'
+});
+
+//specify the properties of the entity to be deleted
+//type is required. UUID or name of the entity to be deleted is also required
+ var properties = {
+ client:client,
+ data:{'type':'item',
+ uuid:'39d25cca-03ad-11e3-a25d-71468ad53e11'
+ }
+};
+
+//create the entity object
+var entity = new Usergrid.Entity(properties);
+
+//call destroy() to initiate the API DELETE request
+entity.destroy(function (error) {
+
+if (error) {
+ // Error
+} else {
+ // Success
+}
+
+});
+ </code></pre>
+<h4 id="response-3"><a href="#response-3">Response:</a></h4>
+<p>The API will respond with 404 Resource Not Found.</p>
+<h3 id="sdk-method-2"><a href="#sdk-method-2">SDK Method</a></h3>
+<pre><code>entity.destroy(callback)</code></pre>
+<h3 id="parameters-1"><a href="#parameters-1">Parameters</a></h3>
+<table>
+<thead><tr class="header">
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody><tr class="odd">
+<td align="left">callback</td>
+<td align="left">Callback function to handle the API response</td>
+</tr></tbody>
+</table><h3 id="example-requestresponse-4"><a href="#example-requestresponse-4">Example Request/Response</a></h3>
+<h4 id="request-4"><a href="#request-4">Request:</a></h4>
+<pre><code>#Create a client object
+usergrid_api = 'https://api.usergrid.com'
+organization = 'your-org'
+application = 'your-app'
+
+client = Usergrid::Application.new "#{usergrid_api}/#{organization}/#{application}"
+
+begin
+ client['items']['milk'].entity.delete
+rescue
+ #fail
+end
+ </code></pre>
+<h4 id="response-4"><a href="#response-4">Response:</a></h4>
+<pre><code>{
+ "action" : "delete",
+ "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/items",
+ "uri" : "http://api.usergrid.com/your-org/your-app/items",
+ "entities" : [ {
+ "uuid" : "328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4",
+ "type" : "item",
+ "name" : "milk",
+ "created" : 1378766158500,
+ "modified" : 1378766158500,
+ "metadata" : {
+ "path" : "/items/328fe64a-19a0-11e3-8a2a-ebc6f49d1fc4"
+ },
+ "name" : "milk",
+ "price" : "3.25"
+ } ],
+ "timestamp" : 1378766172016,
+ "duration" : 324,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+}</code></pre>
+<h3 id="sdk-method-3"><a href="#sdk-method-3">SDK Method</a></h3>
+<pre><code>delete</code></pre>
+<p>This example uses the <a href="/app-services-sdks#nodejs">Apache Usergrid Node.js module</a>.</p>
+<h3 id="example-requestresponse-5"><a href="#example-requestresponse-5">Example Request/Response</a></h3>
+<h4 id="request-5"><a href="#request-5">Request:</a></h4>
+<pre><code>//create the basic client object
+var dataClient = new Usergrid.client({
+orgName:'your-org',
+appName:'your-app'
+});
+
+//specify the properties of the entity to be deleted
+//type is required. UUID or name of the entity to be deleted is also required
+var properties = {
+ client:dataClient,
+ data:{
+ 'type':'item',
+ 'uuid':'39d25cca-03ad-11e3-a25d-71468ad53e11'
+ }
+};
+
+//create the entity object
+var entity = new Usergrid.entity(properties);
+
+//call destroy() to initiate the API DELETE request
+entity.destroy(function (error) {
+
+ if (error) {
+ // Error
+ } else {
+ // Success
+ }
+
+});
+ </code></pre>
+<h4 id="response-5"><a href="#response-5">Response:</a></h4>
+<pre><code>{ action: 'delete',
+ application: 'f34f4222-a166-11e2-a7f7-02e81adcf3d0',
+ params: {},
+ path: '/items',
+ uri: 'http://api.usergrid.com/your-org/your-app/items',
+ entities:
+ [ { uuid: 'f97c35ea-1a5b-11e3-b8a1-6f428da9ad88',
+ type: 'item',
+ name: 'milk',
+ price: '3.25',
+ created: 1378846808126,
+ modified: 1378846808126,
+ metadata: [Object] } ],
+ timestamp: 1378847145757,
+ duration: 285,
+ organization: 'your-org',
+ applicationName: 'your-app' }
+ </code></pre>
+<h3 id="sdk-method-4"><a href="#sdk-method-4">SDK Method</a></h3>
+<pre><code>entity.destroy(callback)</code></pre>
+<h3 id="parameters-2"><a href="#parameters-2">Parameters</a></h3>
+<table>
+<thead><tr class="header">
+<th align="left">Parameter</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody><tr class="odd">
+<td align="left">callback</td>
+<td align="left">Callback function to handle the API response</td>
+</tr></tbody>
+</table><p>Â </p>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-3"></div>
+ <div class="col-md-9">
+ <div class="github-callout">
+ <strong>Questions?</strong> Please do <a href="https://groups.google.com/forum/#!forum/usergrid">ask on the mailing-list</a>!<br/>
+ <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/deleting-data-entities/">this article on github</a>.</div>
+ </div>
+ </div>
+</div>
+
+
+<footer class="bf-footer" role="contentinfo">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="/">Home</a></li>
+ <li class="nav-header"><a href="/community/">Community</a></li>
+ <!-- <li><a href="/community#events">Events</a></li> -->
+ <li><a href="/community/#mailing-lists">Mailing Lists</a></li>
+ <li><a href="/community/#deployments">Deployments</a></li>
+ <li><a href="/community/#committers">Commiters</a></li>
+ <!-- <li class="nav-header"><a href="#">Docs</a></li> -->
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="https://github.com/usergrid/usergrid/" target="_blank">Code</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet" target="_blank">.NET / Windows SDK</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header">Resources</li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank">GitHub Code</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank">JIRA Bug Tracker</a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4">IRC</a></li>
+ <li><a href="https://twitter.com/usergrid" target="_blank">Twitter</a></li>
+ <li><a href="http://incubator.apache.org/projects/usergrid.html" target="_blank">Podling Listing</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/LICENSE" target="_blank">License</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#contributing" target="_blank">Contribution Guidelines</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2"></div>
+ <div class="col-md-4">
+ <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid" data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a>
+ <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ </div>
+ <!--
+ <div class="col-md-4">
+ <div class="input-group form-search">
+ <input type="text" class="form-control search-query">
+ <span class="input-group-btn">
+ <button type="submit" class="btn btn-primary" data-type="last">Search</button>
+ </span>
+ </div>
+ </div> -->
+ </div>
+ <div class="row">
+ <div id="copyright">
+ <img src="/img/egg-logo.png" /><br/><br/>
+ <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
+ <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br>
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p>
+ <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee">@ryuneeee</a> + <a href="https://github.com/realbeast">@realbeast</a> + <a href="https://twitter.com/timanglade">@timanglade</a>.</p>
+ </div>
+ </div>
+ </div>
+</footer>
+
+<script type="text/javascript" src="/js/head.js"></script>
+<script type="text/javascript">
+ head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js");
+</script>
+<script type="text/javascript">
+ //IE outdate friendly warning if you don't want remove it
+ var $buoop = {vs:{i:8,f:3.6,o:10.6,s:3.2,n:9}}
+ $buoop.ol = window.onload;
+ window.onload=function(){
+ try {if ($buoop.ol) $buoop.ol();}catch (e) {}
+ var e = document.createElement("script");
+ e.setAttribute("type", "text/javascript");
+ e.setAttribute("src", "http://browser-update.org/update.js");
+ document.body.appendChild(e);
+ }
+</script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/docs/device/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/device/index.html?rev=1542910&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/device/index.html (added)
+++ incubator/usergrid/site/publish/docs/device/index.html Mon Nov 18 06:09:23 2013
@@ -0,0 +1,297 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) â Device</title>
+ <meta http-equiv="x-ua-compatible" content="ie=edge" />
+ <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" />
+ <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service">
+ <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <meta property="og:title" content="Apache Usergrid" />
+ <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <!-- Loading Typekit -->
+ <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script>
+ <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
+ <!-- Loading Bootstrap -->
+ <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'>
+ <link href="/css/bootflat.css" rel="stylesheet" type='text/css'>
+ <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'>
+ <link href="http://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic" rel="stylesheet" type="text/css">
+ <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
+
+
+
+ <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
+ <!--[if lt IE 9]>
+ <script src="js/html5shiv.js"></script>
+ <script src="js/respond.min.js"></script>
+ <![endif]-->
+</head>
+<body>
+
+ <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner">
+ <div class="container">
+ <div class="navbar-header">
+ <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a href="/" class="navbar-brand">
+ <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
+ </a>
+ </div>
+ <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
+ <ul class="nav navbar-nav navbar-right">
+ <!--<li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>-->
+ <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank"><span class="icns icon-github-sign"></span></a></li>
+ <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span class="icns icon-trello"></span></a></li>-->
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank"><span class="icns icon-bug"></span></a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank"><span class="icns icon-stackexchange"></span></a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4" target="_blank"><span class="icns icon-comments"></span></a></li>
+ <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid" target="_blank"><span class="icns icon-envelope"></span></a></li>-->
+ <li><a href="https://twitter.com/usergrid" target="_blank"><span class="icns icon-twitter"></span></a></li>
+ </ul>
+ </nav>
+ </div>
+ </header>
+
+
+<div class="container bf-docs-container">
+ <div class="row">
+ <div class="col-md-3">
+ <div class="bf-sidebar hidden-print" role="complementary">
+ <ul class="nav nav-list">
+ <li><a href="#">Getting Up & Running Locally</a></li>
+ <li><a href="#"><code>ugc</code> â the Command-line Client</a></li>
+
+ <li class="nav-header"><span>Concepts</span></li>
+ <li>
+ <a href="/docs/organizations-admins/">Organizations & Admins</a>
+ <ul>
+ <li>
+ <a href="/docs/applications">Applications</a>
+ <ul>
+ <li><a href="#">Roles & Permissions</a></li>
+ <li><a href="#">Queues</a></li>
+ <li><a href="#">Events & Counters</a></li>
+ <li>
+ <a href="#">Collections</a>
+ <ul>
+ <li><a href="#">Query Language</a></li>
+ <li><a href="#">Users & Devices</a></li>
+ <li><a href="#">Groups</a></li>
+ <li><a href="#">Activities</a></li>
+ <li><a href="#">Assets</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-header"><span>Usage</span></li>
+ <li><a href="/docs/rest-api">REST API</a></li>
+ <li><a class="icns-apple" href="#">iOS SDK</a></li>
+ <li><a class="icns-android" href="#">Android SDK</a></li>
+ <li><a class="icns-html5" href="/docs/html5-javascript-sdk">HTML5 / JavaScript SDK</a></li>
+ <li><a class="icns-windows" href="#">Windows 8 / Windows Phone / .net SDK</a></li>
+ <li><a href="/docs/nodejs-module">Node.js module</a></li>
+ <li><a href="/docs/ruby-gem">Ruby gem</a></li>
+ <li><a href="#">Ruby on Rails gem</a></li>
+ <li><a href="#">PHP library</a></li>
+
+ <li class="nav-header"><span>Internals</span></li>
+ <li><a href="#">Design & Goals</a></li>
+ <li><a href="#">Java Architecture</a></li>
+ <li><a href="#">Cassandra Schema</a></li>
+ <li><a href="#">Contributing</a></li>
+
+ <li class="nav-header"><span>Operations</span></li>
+ <li><a href="#">Deploying</a></li>
+ <li><a href="#">Monitoring</a></li>
+ <li><a href="#">Upgrading</a></li>
+ <li><a href="#">Security</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div class="col-md-9 main-article" role="main">
+ <div class="page-article">
+ <div class="page-header">
+ <h1>Device</h1>
+ <small><a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/device/">contribute to this article on github</a></small>
+ </div>
+ <div class="toc">
+ <ul>
+<li>
+<a href="#device">Device</a><ul>
+<li><a href="#device-properties">Device properties</a></li>
+<li><a href="#associated-collection-property">Associated collection property</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<h1 id="device"><a href="#device">Device</a></h1>
+<p>Using App services APIs you can create, retrieve, update, delete, and query device entities. See You do not have access to view this node for descriptions of these APIs.</p>
+<h2 id="device-properties"><a href="#device-properties">Device properties</a></h2>
+<p>The following are the system-defined properties for device entities. You can create application-specific properties for a device entity in addition to the system-defined properties. The system-defined properties are reserved. You cannot use these names to create other properties for a device entity. In addition the devices name is reserved for the devices collection â you canât use it to name another collection.</p>
+<table>
+<thead><tr class="header">
+<th align="left">Property</th>
+<th align="left">Type</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody>
+<tr class="odd">
+<td align="left">uuid</td>
+<td align="left">UUID</td>
+<td align="left">Entity unique ID</td>
+</tr>
+<tr class="even">
+<td align="left">type</td>
+<td align="left">string</td>
+<td align="left">Entity type (e.g., device)</td>
+</tr>
+<tr class="odd">
+<td align="left">created</td>
+<td align="left">long</td>
+<td align="left">
+<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity creation</td>
+</tr>
+<tr class="even">
+<td align="left">modified</td>
+<td align="left">long</td>
+<td align="left">
+<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity modification</td>
+</tr>
+<tr class="odd">
+<td align="left">name</td>
+<td align="left">string</td>
+<td align="left">Device name (mandatory)</td>
+</tr>
+</tbody>
+</table><h2 id="associated-collection-property"><a href="#associated-collection-property">Associated collection property</a></h2>
+<p>Devices have the following associated collection.</p>
+<table>
+<thead><tr class="header">
+<th align="left">Collection</th>
+<th align="left">Type</th>
+<th align="left">Description</th>
+</tr></thead>
+<tbody><tr class="odd">
+<td align="left">users</td>
+<td align="left">user</td>
+<td align="left">Collection of users to which a device belongs</td>
+</tr></tbody>
+</table><p>Â </p>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-3"></div>
+ <div class="col-md-9">
+ <div class="github-callout">
+ <strong>Questions?</strong> Please do <a href="https://groups.google.com/forum/#!forum/usergrid">ask on the mailing-list</a>!<br/>
+ <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/device/">this article on github</a>.</div>
+ </div>
+ </div>
+</div>
+
+
+<footer class="bf-footer" role="contentinfo">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="/">Home</a></li>
+ <li class="nav-header"><a href="/community/">Community</a></li>
+ <!-- <li><a href="/community#events">Events</a></li> -->
+ <li><a href="/community/#mailing-lists">Mailing Lists</a></li>
+ <li><a href="/community/#deployments">Deployments</a></li>
+ <li><a href="/community/#committers">Commiters</a></li>
+ <!-- <li class="nav-header"><a href="#">Docs</a></li> -->
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="https://github.com/usergrid/usergrid/" target="_blank">Code</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet" target="_blank">.NET / Windows SDK</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header">Resources</li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank">GitHub Code</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank">JIRA Bug Tracker</a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4">IRC</a></li>
+ <li><a href="https://twitter.com/usergrid" target="_blank">Twitter</a></li>
+ <li><a href="http://incubator.apache.org/projects/usergrid.html" target="_blank">Podling Listing</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/LICENSE" target="_blank">License</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#contributing" target="_blank">Contribution Guidelines</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2"></div>
+ <div class="col-md-4">
+ <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid" data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a>
+ <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ </div>
+ <!--
+ <div class="col-md-4">
+ <div class="input-group form-search">
+ <input type="text" class="form-control search-query">
+ <span class="input-group-btn">
+ <button type="submit" class="btn btn-primary" data-type="last">Search</button>
+ </span>
+ </div>
+ </div> -->
+ </div>
+ <div class="row">
+ <div id="copyright">
+ <img src="/img/egg-logo.png" /><br/><br/>
+ <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
+ <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br>
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p>
+ <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee">@ryuneeee</a> + <a href="https://github.com/realbeast">@realbeast</a> + <a href="https://twitter.com/timanglade">@timanglade</a>.</p>
+ </div>
+ </div>
+ </div>
+</footer>
+
+<script type="text/javascript" src="/js/head.js"></script>
+<script type="text/javascript">
+ head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js");
+</script>
+<script type="text/javascript">
+ //IE outdate friendly warning if you don't want remove it
+ var $buoop = {vs:{i:8,f:3.6,o:10.6,s:3.2,n:9}}
+ $buoop.ol = window.onload;
+ window.onload=function(){
+ try {if ($buoop.ol) $buoop.ol();}catch (e) {}
+ var e = document.createElement("script");
+ e.setAttribute("type", "text/javascript");
+ e.setAttribute("src", "http://browser-update.org/update.js");
+ document.body.appendChild(e);
+ }
+</script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/docs/displaying-app-services-api-calls-curl-commands/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/displaying-app-services-api-calls-curl-commands/index.html?rev=1542910&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/displaying-app-services-api-calls-curl-commands/index.html (added)
+++ incubator/usergrid/site/publish/docs/displaying-app-services-api-calls-curl-commands/index.html Mon Nov 18 06:09:23 2013
@@ -0,0 +1,264 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) â Displaying Apache Usergrid API calls as Curl commands</title>
+ <meta http-equiv="x-ua-compatible" content="ie=edge" />
+ <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" />
+ <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service">
+ <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <meta property="og:title" content="Apache Usergrid" />
+ <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <!-- Loading Typekit -->
+ <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script>
+ <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
+ <!-- Loading Bootstrap -->
+ <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'>
+ <link href="/css/bootflat.css" rel="stylesheet" type='text/css'>
+ <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'>
+ <link href="http://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic" rel="stylesheet" type="text/css">
+ <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
+
+
+
+ <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
+ <!--[if lt IE 9]>
+ <script src="js/html5shiv.js"></script>
+ <script src="js/respond.min.js"></script>
+ <![endif]-->
+</head>
+<body>
+
+ <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner">
+ <div class="container">
+ <div class="navbar-header">
+ <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a href="/" class="navbar-brand">
+ <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
+ </a>
+ </div>
+ <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
+ <ul class="nav navbar-nav navbar-right">
+ <!--<li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>-->
+ <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank"><span class="icns icon-github-sign"></span></a></li>
+ <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span class="icns icon-trello"></span></a></li>-->
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank"><span class="icns icon-bug"></span></a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank"><span class="icns icon-stackexchange"></span></a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4" target="_blank"><span class="icns icon-comments"></span></a></li>
+ <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid" target="_blank"><span class="icns icon-envelope"></span></a></li>-->
+ <li><a href="https://twitter.com/usergrid" target="_blank"><span class="icns icon-twitter"></span></a></li>
+ </ul>
+ </nav>
+ </div>
+ </header>
+
+
+<div class="container bf-docs-container">
+ <div class="row">
+ <div class="col-md-3">
+ <div class="bf-sidebar hidden-print" role="complementary">
+ <ul class="nav nav-list">
+ <li><a href="#">Getting Up & Running Locally</a></li>
+ <li><a href="#"><code>ugc</code> â the Command-line Client</a></li>
+
+ <li class="nav-header"><span>Concepts</span></li>
+ <li>
+ <a href="/docs/organizations-admins/">Organizations & Admins</a>
+ <ul>
+ <li>
+ <a href="/docs/applications">Applications</a>
+ <ul>
+ <li><a href="#">Roles & Permissions</a></li>
+ <li><a href="#">Queues</a></li>
+ <li><a href="#">Events & Counters</a></li>
+ <li>
+ <a href="#">Collections</a>
+ <ul>
+ <li><a href="#">Query Language</a></li>
+ <li><a href="#">Users & Devices</a></li>
+ <li><a href="#">Groups</a></li>
+ <li><a href="#">Activities</a></li>
+ <li><a href="#">Assets</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-header"><span>Usage</span></li>
+ <li><a href="/docs/rest-api">REST API</a></li>
+ <li><a class="icns-apple" href="#">iOS SDK</a></li>
+ <li><a class="icns-android" href="#">Android SDK</a></li>
+ <li><a class="icns-html5" href="/docs/html5-javascript-sdk">HTML5 / JavaScript SDK</a></li>
+ <li><a class="icns-windows" href="#">Windows 8 / Windows Phone / .net SDK</a></li>
+ <li><a href="/docs/nodejs-module">Node.js module</a></li>
+ <li><a href="/docs/ruby-gem">Ruby gem</a></li>
+ <li><a href="#">Ruby on Rails gem</a></li>
+ <li><a href="#">PHP library</a></li>
+
+ <li class="nav-header"><span>Internals</span></li>
+ <li><a href="#">Design & Goals</a></li>
+ <li><a href="#">Java Architecture</a></li>
+ <li><a href="#">Cassandra Schema</a></li>
+ <li><a href="#">Contributing</a></li>
+
+ <li class="nav-header"><span>Operations</span></li>
+ <li><a href="#">Deploying</a></li>
+ <li><a href="#">Monitoring</a></li>
+ <li><a href="#">Upgrading</a></li>
+ <li><a href="#">Security</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div class="col-md-9 main-article" role="main">
+ <div class="page-article">
+ <div class="page-header">
+ <h1>Displaying Apache Usergrid API calls as Curl commands</h1>
+ <small><a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/displaying-app-services-api-calls-curl-commands/">contribute to this article on github</a></small>
+ </div>
+ <div class="toc">
+ <ul>
+<li><a href="#displaying-apache-usergrid-api-calls-as-curl-commands">Displaying Apache Usergrid API calls as Curl commands</a></li>
+</ul>
+</div>
+<h1 id="displaying-apache-usergrid-api-calls-as-curl-commands"><a href="#displaying-apache-usergrid-api-calls-as-curl-commands">Displaying Apache Usergrid API calls as Curl commands</a></h1>
+<p>Â </p>
+<p>If you use a web application, such as the JavaScript (HTML 5) version of Messagee (see <a href="/html-5-example-messagee">HTML 5 example - Messagee</a>), you can easily see the equivalent Curl syntax for each API call that the web application makes. The calls are displayed in the console area of any of the following browsers: Â Chrome, Internet Explorer (in the debugger), Firefox (in Firebug), and Safari.</p>
+<p>This is possible because web applications such as the JavaScript version of Message takes advantage of a JavaScript SDK provied by Apigee (see <a href="/html5javascript-sdk">HTML5/JavaScript SDK</a>)Â to issue Apache Usergrid API calls. The SDK automatically translates each API call into a Curl command, which is displayed in the console. If you use any web application that is built on the JavaScript SDK, you can view the applications APIâs calls in Curl syntax.</p>
+<p>The <a href="http://apigee.com/usergrid/">admin portal</a>Â is another example of a web application that is built on the JavaScript SDK and issues App Services API calls from JavaScript. When a user clicks a button in the admin portal, such as âUsersâ, the admin portal makes an API request to retrieve the appropriate data. In addition, the JavaScript SDK in the web application automatically translates the API call into the following Curl command:</p>
+<pre><code>curl -X GET "https://api.usergrid.com/edort1/sandbox/users?ql=order%20by%20usernameâ</code></pre>
+<p>The request retrieves the users in the application and orders the result by username.</p>
+<p>If you turn on the JavaScript console, hereâs what it displays for the call. This example shows the JavaScript console display in the Chrome browser. You can turn on the JavaScript console in Chrome by clicking the âwrenchâ button (customize and control Chrome) and then selecting Tools > JavaScript console. </p>
+<div class="figure">
+<img src="/docs/sites/docs/files/jsconsole_chrome.png" alt="Curl command in Chrome console"><p class="caption">Curl command in Chrome console</p>
+</div>
+<p>Notice that in addition to displaying the API call in Curl syntax, the console displays the time to retrieve the user entities.</p>
+<p>To display the JavaScript console in Internet Explorer, you need to turn on the debugger. You do that by selecting F12 developer tools in the tools menu. Hereâs what the Curl version of the API call looks like in Internet Explorerâs console.</p>
+<div class="figure">
+<img src="/docs/sites/docs/files/jsconsole_ie.png" alt="Curl command in Internet Explorer console"><p class="caption">Curl command in Internet Explorer console</p>
+</div>
+<p>Hereâs what the curl version of the API call looks like in Firefoxâs JavaScript console.</p>
+<div class="figure">
+<img src="/docs/sites/docs/files/jsconsole_firefox.png" alt="Curl command in Firefox console"><p class="caption">Curl command in Firefox console</p>
+</div>
+<p>You need to have the <a href="http://getfirebug.com/">Firebug tool</a>Â installed and enabled in your Firefox browser to view the curl commands in the console.</p>
+<p>And hereâs what the API call looks like in the Safari console. The console is part of Safariâs Web Inspector tool (<a href="https://developer.apple.com/technologies/safari/developer-tools.html">https://developer.apple.com/technologies/safari/developer-tools.html</a>).</p>
+<div class="figure">
+<img src="/docs/sites/docs/files/jsconsole_safari.png" alt="Curl command in SaFARI"><p class="caption">Curl command in SaFARI</p>
+</div>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-3"></div>
+ <div class="col-md-9">
+ <div class="github-callout">
+ <strong>Questions?</strong> Please do <a href="https://groups.google.com/forum/#!forum/usergrid">ask on the mailing-list</a>!<br/>
+ <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/displaying-app-services-api-calls-curl-commands/">this article on github</a>.</div>
+ </div>
+ </div>
+</div>
+
+
+<footer class="bf-footer" role="contentinfo">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="/">Home</a></li>
+ <li class="nav-header"><a href="/community/">Community</a></li>
+ <!-- <li><a href="/community#events">Events</a></li> -->
+ <li><a href="/community/#mailing-lists">Mailing Lists</a></li>
+ <li><a href="/community/#deployments">Deployments</a></li>
+ <li><a href="/community/#committers">Commiters</a></li>
+ <!-- <li class="nav-header"><a href="#">Docs</a></li> -->
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="https://github.com/usergrid/usergrid/" target="_blank">Code</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet" target="_blank">.NET / Windows SDK</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header">Resources</li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank">GitHub Code</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank">JIRA Bug Tracker</a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4">IRC</a></li>
+ <li><a href="https://twitter.com/usergrid" target="_blank">Twitter</a></li>
+ <li><a href="http://incubator.apache.org/projects/usergrid.html" target="_blank">Podling Listing</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/LICENSE" target="_blank">License</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#contributing" target="_blank">Contribution Guidelines</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2"></div>
+ <div class="col-md-4">
+ <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid" data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a>
+ <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ </div>
+ <!--
+ <div class="col-md-4">
+ <div class="input-group form-search">
+ <input type="text" class="form-control search-query">
+ <span class="input-group-btn">
+ <button type="submit" class="btn btn-primary" data-type="last">Search</button>
+ </span>
+ </div>
+ </div> -->
+ </div>
+ <div class="row">
+ <div id="copyright">
+ <img src="/img/egg-logo.png" /><br/><br/>
+ <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
+ <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br>
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p>
+ <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee">@ryuneeee</a> + <a href="https://github.com/realbeast">@realbeast</a> + <a href="https://twitter.com/timanglade">@timanglade</a>.</p>
+ </div>
+ </div>
+ </div>
+</footer>
+
+<script type="text/javascript" src="/js/head.js"></script>
+<script type="text/javascript">
+ head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js");
+</script>
+<script type="text/javascript">
+ //IE outdate friendly warning if you don't want remove it
+ var $buoop = {vs:{i:8,f:3.6,o:10.6,s:3.2,n:9}}
+ $buoop.ol = window.onload;
+ window.onload=function(){
+ try {if ($buoop.ol) $buoop.ol();}catch (e) {}
+ var e = document.createElement("script");
+ e.setAttribute("type", "text/javascript");
+ e.setAttribute("src", "http://browser-update.org/update.js");
+ document.body.appendChild(e);
+ }
+</script>
+
+
+</body>
+</html>
\ No newline at end of file
Added: incubator/usergrid/site/publish/docs/entity-relationships/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/entity-relationships/index.html?rev=1542910&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/entity-relationships/index.html (added)
+++ incubator/usergrid/site/publish/docs/entity-relationships/index.html Mon Nov 18 06:09:23 2013
@@ -0,0 +1,287 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) â Entity relationships</title>
+ <meta http-equiv="x-ua-compatible" content="ie=edge" />
+ <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" />
+ <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service">
+ <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <meta property="og:title" content="Apache Usergrid" />
+ <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
+ <!-- Loading Typekit -->
+ <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script>
+ <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
+ <!-- Loading Bootstrap -->
+ <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'>
+ <link href="/css/bootflat.css" rel="stylesheet" type='text/css'>
+ <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'>
+ <link href="http://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic" rel="stylesheet" type="text/css">
+ <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
+
+
+
+ <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
+ <!--[if lt IE 9]>
+ <script src="js/html5shiv.js"></script>
+ <script src="js/respond.min.js"></script>
+ <![endif]-->
+</head>
+<body>
+
+ <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner">
+ <div class="container">
+ <div class="navbar-header">
+ <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a href="/" class="navbar-brand">
+ <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
+ </a>
+ </div>
+ <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
+ <ul class="nav navbar-nav navbar-right">
+ <!--<li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>-->
+ <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank"><span class="icns icon-github-sign"></span></a></li>
+ <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span class="icns icon-trello"></span></a></li>-->
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank"><span class="icns icon-bug"></span></a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank"><span class="icns icon-stackexchange"></span></a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4" target="_blank"><span class="icns icon-comments"></span></a></li>
+ <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid" target="_blank"><span class="icns icon-envelope"></span></a></li>-->
+ <li><a href="https://twitter.com/usergrid" target="_blank"><span class="icns icon-twitter"></span></a></li>
+ </ul>
+ </nav>
+ </div>
+ </header>
+
+
+<div class="container bf-docs-container">
+ <div class="row">
+ <div class="col-md-3">
+ <div class="bf-sidebar hidden-print" role="complementary">
+ <ul class="nav nav-list">
+ <li><a href="#">Getting Up & Running Locally</a></li>
+ <li><a href="#"><code>ugc</code> â the Command-line Client</a></li>
+
+ <li class="nav-header"><span>Concepts</span></li>
+ <li>
+ <a href="/docs/organizations-admins/">Organizations & Admins</a>
+ <ul>
+ <li>
+ <a href="/docs/applications">Applications</a>
+ <ul>
+ <li><a href="#">Roles & Permissions</a></li>
+ <li><a href="#">Queues</a></li>
+ <li><a href="#">Events & Counters</a></li>
+ <li>
+ <a href="#">Collections</a>
+ <ul>
+ <li><a href="#">Query Language</a></li>
+ <li><a href="#">Users & Devices</a></li>
+ <li><a href="#">Groups</a></li>
+ <li><a href="#">Activities</a></li>
+ <li><a href="#">Assets</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-header"><span>Usage</span></li>
+ <li><a href="/docs/rest-api">REST API</a></li>
+ <li><a class="icns-apple" href="#">iOS SDK</a></li>
+ <li><a class="icns-android" href="#">Android SDK</a></li>
+ <li><a class="icns-html5" href="/docs/html5-javascript-sdk">HTML5 / JavaScript SDK</a></li>
+ <li><a class="icns-windows" href="#">Windows 8 / Windows Phone / .net SDK</a></li>
+ <li><a href="/docs/nodejs-module">Node.js module</a></li>
+ <li><a href="/docs/ruby-gem">Ruby gem</a></li>
+ <li><a href="#">Ruby on Rails gem</a></li>
+ <li><a href="#">PHP library</a></li>
+
+ <li class="nav-header"><span>Internals</span></li>
+ <li><a href="#">Design & Goals</a></li>
+ <li><a href="#">Java Architecture</a></li>
+ <li><a href="#">Cassandra Schema</a></li>
+ <li><a href="#">Contributing</a></li>
+
+ <li class="nav-header"><span>Operations</span></li>
+ <li><a href="#">Deploying</a></li>
+ <li><a href="#">Monitoring</a></li>
+ <li><a href="#">Upgrading</a></li>
+ <li><a href="#">Security</a></li>
+ </ul>
+ </div>
+ </div>
+
+ <div class="col-md-9 main-article" role="main">
+ <div class="page-article">
+ <div class="page-header">
+ <h1>Entity relationships</h1>
+ <small><a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/entity-relationships/">contribute to this article on github</a></small>
+ </div>
+ <div class="toc">
+ <ul>
+<li>
+<a href="#entity-relationships">Entity relationships</a><ul>
+<li><a href="#creating-connections-between-entities">Creating connections between entities</a></li>
+<li><a href="#creating-other-connections">Creating other connections</a></li>
+<li>
+<a href="#getting-connections">Getting connections</a><ul>
+<li><a href="#get-all-connections-for-an-entity">Get all connections for an entity</a></li>
+<li><a href="#get-information-on-a-specific-connection-type">Get information on a specific connection type</a></li>
+</ul>
+</li>
+<li><a href="#deleting-a-connection">Deleting a connection</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<h1 id="entity-relationships"><a href="#entity-relationships">Entity relationships</a></h1>
+<h2 id="creating-connections-between-entities"><a href="#creating-connections-between-entities">Creating connections between entities</a></h2>
+<p>One of the most useful features of App services is the ability to create connections between entities. A simple example of this is the Twitter-like use of <em>following</em>, where one user forms a connection with another by subscribing to any tweets they post. <a href="/messagee-example">Messagee Example</a> walks you through an example of following other users in our sample app, <em>Messagee</em>. Here is the basic format:</p>
+<pre><code>POST https://api.usergrid.com/my-org/my-app/users/fred/following/users/barney</code></pre>
+<p>This API call results in two users, Fred and Barney, linked with a connection where Fred is following Barney.</p>
+<p>If you create a <em>following</em> connection between two users, Apache Usergrid automatically creates a virtual connection called <em>followers</em> that mirrors the <em>following</em> connection. In other words, if you create a connection where Fred is following Barney, Apache Usergrid automatically creates a virtual connection where Fred is a follower of Barney.</p>
+<p>Note that there is no mirror connection established. Apache Usergrid only creates a mirror connection when you create a <em>following</em> connection. It does not create a mirror connection for other verbs such as likes.</p>
+<p>You can see all the users that Fred is following, in this case only Barney, by making the following API call:</p>
+<pre><code>GET https://api.usergrid.com/my-org/my-app/users/fred/following</code></pre>
+<p>You can see all of barneyâs followers, in this case only Fred, by making the following API call:</p>
+<pre><code>GET https://api.usergrid.com/my-org/my-app/users/barney/followers</code></pre>
+<p>The <em>followers</em> connection is a virtual connection because you canât use it to link two entities. In other words, you canât make fred a follower of barney by using a <em>followers</em> connection. Â <strong>This is wrong:</strong></p>
+<pre><code>POST https://api.usergrid.com/my-org/my-app/users/barney/followers/users/fred</code></pre>
+<p>To create a <em>following</em> connection with the users switched, so that Barney is following Fred, do this:</p>
+<pre><code>POST https://api.usergrid.com/my-org/my-app/users/barney/following/users/fred</code></pre>
+<p>You can now see Fredâs followers (only Barney) by making the following call:</p>
+<pre><code>GET https://api.usergrid.com/my-org/my-app/users/fred/followers</code></pre>
+<h2 id="creating-other-connections"><a href="#creating-other-connections">Creating other connections</a></h2>
+<p>You can extend this connection structure to create connections using any âverbâ that can link two entities. For example, you could use likes to denote a connection between a user and his dog. First, create a dogs collection:</p>
+<pre><code>POST https://api.usergrid.com/my-org/my-app/dogs</code></pre>
+<p>Then populate this collection with a new dog named Dino:</p>
+<pre><code>POST https://api.usergrid.com/my-org/my-app/dogs {"name" : "dino"}</code></pre>
+<p>Then create a likes connection between Fred and his dog Dino:</p>
+<pre><code>POST https://api.usergrid.com/my-org/my-app/users/fred/likes/dogs/dino</code></pre>
+<h2 id="getting-connections"><a href="#getting-connections">Getting connections</a></h2>
+<h3 id="get-all-connections-for-an-entity"><a href="#get-all-connections-for-an-entity">Get all connections for an entity</a></h3>
+<p>To get a list that only contains the connections, do a GET on the connections sub-property of the entity:</p>
+<pre><code>GET https://api.usergrid.com/my-org/my-app/users/fred/connections</code></pre>
+<h3 id="get-information-on-a-specific-connection-type"><a href="#get-information-on-a-specific-connection-type">Get information on a specific connection type</a></h3>
+<p>To get a list of users who like Fred:</p>
+<pre><code>GET https://api.usergrid.com/my-org/my-app/users/fred/connecting/likes</code></pre>
+<p>To get a list of all dogs that Fred likes:</p>
+<pre><code>GET https://api.usergrid.com/my-org/my-app/users/fred/likes/dog</code></pre>
+<h2 id="deleting-a-connection"><a href="#deleting-a-connection">Deleting a connection</a></h2>
+<p>You can delete a connection in a way similar to creating one. Just replace the POST method with the DELETE method. For example, you can delete the connection between fred and barney with the following API call:</p>
+<pre><code>DELETE https://api.usergrid.com/my-org/my-app/users/fred/following/barney</code></pre>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-3"></div>
+ <div class="col-md-9">
+ <div class="github-callout">
+ <strong>Questions?</strong> Please do <a href="https://groups.google.com/forum/#!forum/usergrid">ask on the mailing-list</a>!<br/>
+ <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/entity-relationships/">this article on github</a>.</div>
+ </div>
+ </div>
+</div>
+
+
+<footer class="bf-footer" role="contentinfo">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="/">Home</a></li>
+ <li class="nav-header"><a href="/community/">Community</a></li>
+ <!-- <li><a href="/community#events">Events</a></li> -->
+ <li><a href="/community/#mailing-lists">Mailing Lists</a></li>
+ <li><a href="/community/#deployments">Deployments</a></li>
+ <li><a href="/community/#committers">Commiters</a></li>
+ <!-- <li class="nav-header"><a href="#">Docs</a></li> -->
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header"><a href="https://github.com/usergrid/usergrid/" target="_blank">Code</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet" target="_blank">.NET / Windows SDK</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2">
+ <ul class="nav nav-list">
+ <li class="nav-header">Resources</li>
+ <li><a href="http://github.com/usergrid/usergrid" target="_blank">GitHub Code</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/USERGRID" target="_blank">JIRA Bug Tracker</a></li>
+ <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
+ <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4">IRC</a></li>
+ <li><a href="https://twitter.com/usergrid" target="_blank">Twitter</a></li>
+ <li><a href="http://incubator.apache.org/projects/usergrid.html" target="_blank">Podling Listing</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/LICENSE" target="_blank">License</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
+ <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#contributing" target="_blank">Contribution Guidelines</a></li>
+ </ul>
+ </div>
+ <div class="col-md-2"></div>
+ <div class="col-md-4">
+ <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid" data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a>
+ <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+ </div>
+ <!--
+ <div class="col-md-4">
+ <div class="input-group form-search">
+ <input type="text" class="form-control search-query">
+ <span class="input-group-btn">
+ <button type="submit" class="btn btn-primary" data-type="last">Search</button>
+ </span>
+ </div>
+ </div> -->
+ </div>
+ <div class="row">
+ <div id="copyright">
+ <img src="/img/egg-logo.png" /><br/><br/>
+ <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
+ <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br>
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p>
+ <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee">@ryuneeee</a> + <a href="https://github.com/realbeast">@realbeast</a> + <a href="https://twitter.com/timanglade">@timanglade</a>.</p>
+ </div>
+ </div>
+ </div>
+</footer>
+
+<script type="text/javascript" src="/js/head.js"></script>
+<script type="text/javascript">
+ head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js");
+</script>
+<script type="text/javascript">
+ //IE outdate friendly warning if you don't want remove it
+ var $buoop = {vs:{i:8,f:3.6,o:10.6,s:3.2,n:9}}
+ $buoop.ol = window.onload;
+ window.onload=function(){
+ try {if ($buoop.ol) $buoop.ol();}catch (e) {}
+ var e = document.createElement("script");
+ e.setAttribute("type", "text/javascript");
+ e.setAttribute("src", "http://browser-update.org/update.js");
+ document.body.appendChild(e);
+ }
+</script>
+
+
+</body>
+</html>
\ No newline at end of file