You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2015/07/17 17:42:45 UTC
[20/51] [partial] incubator-usergrid git commit: Update for Usergrid
1.0.2 release and remove old /website/publish directory because it is
replaced by /content.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/ec2b3e4f/website/publish/docs/retrieving-data-entities/index.html
----------------------------------------------------------------------
diff --git a/website/publish/docs/retrieving-data-entities/index.html b/website/publish/docs/retrieving-data-entities/index.html
deleted file mode 100644
index 673ae16..0000000
--- a/website/publish/docs/retrieving-data-entities/index.html
+++ /dev/null
@@ -1,1336 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
- <meta charset="utf-8">
- <title>Apache Usergrid (incubating) — Retrieving 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="https://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>
- </div>
- <a href="/" class="navbar-brand">
- <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
- </a>
- <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
- <ul class="nav navbar-nav navbar-right">
- <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
- <li><a href="http://usergrid.readthedocs.org/" target="_blank"><span class="icns icon-book"></span></a></li>
- <li><a href="http://github.com/apache/incubator-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/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible" 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="/community/#live"><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>
- <li><a href="https://cwiki.apache.org/confluence/display/usergrid/" target="_blank"><span class="icns icon-wiki"></span></a></li>
- <li><a href="/releases/"><span class="icns icon-releases"></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="/docs/getting-up-and-running-locally/">Getting Up & Running Locally</a></li>
- <li><a href="/docs/deploy-local/">Deploying to local Tomcat & Cassandra</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/tree/master/ugc#usergrid-command-line-ugc"><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="/docs/roles-and-permissions/">Roles & Permissions</a></li>
- <!--<li><a href="#">Queues</a></li>-->
- <li><a href="/docs/events-and-counters/">Events & Counters</a></li>
- <li><a href="/docs/relationships/">Relationships (Joins)</a></li>
- <li>
- <a href="/docs/collections">Collections</a>
- <ul>
- <li><a href="/docs/query-language/">Query Language</a></li>
- <li><a href="/docs/users-devices/">Users & Devices</a></li>
- <li><a href="/docs/groups/">Groups</a></li>
- <li><a href="/docs/activities/">Activities</a></li>
- <li><a href="/docs/assets/">Assets</a></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </li>
-
-
- <li class="nav-header"><span>Usage</span></li>
- <!-- <li>REST API — Coming Soon</li> -->
- <li><a class="icns-apple" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ios">iOS SDK</a></li>
- <li><a class="icns-android" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/android">Android SDK</a></li>
- <li><a class="icns-html5" href="">HTML5 / JavaScript SDK</a></li>
- <li><a class="icns-windows" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/dotnet">Windows 8 / Windows Phone / .net SDK</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/nodejs">Node.js module</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby">Ruby gem</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby-on-rails">Ruby on Rails gem</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/php">PHP library</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/java">Java library</a></li>
-
- <!--<li class="nav-header"><span>Internals</span></li>
- <li>Design & Goals — Coming Soon</li>
- <li>Java Architecture — Coming Soon</li>
- <li>Cassandra Schema — Coming Soon</li>-->
-
- <li class="nav-header"><span>Operations</span></li>
- <!--<li>Deploying — Coming Soon</li>-->
- <!-- <li>Monitoring — Coming Soon</li> -->
- <li><a href="/docs/upgrading/">Upgrading</a></li>
- <!-- <li>Security — Coming Soon</li> -->
-
- <li class="nav-header"><span>Presentations & Videos</span></li>
- <li><a href="/docs/presentations/">Presentations</a></li>
- <li><a href="/docs/videos/">Videos</a></li>
-
- <li class="nav-header"><span>We need your help!</span></li>
- <li><a href="/docs/contribute-code/">How to Contribute Code & Docs</a></li>
- <!--
- <li><a href="/docs/contribute-docs">How to contribute docs</a></li>
- -->
- </ul>
- </div>
- </div>
-
- <div class="col-md-9 main-article" role="main">
- <div class="page-article">
- <div class="page-header">
- <h1>Retrieving Data Entities</h1>
- <!-- TODO: reenable this when we sync SVN to GitHub
- <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/retrieving-data-entities.md">contribute to this article on github</a></small>
- -->
- </div>
- <div class="toc">
- <ul>
-<li>
-<a href="#retrieving-data-entities">Retrieving Data Entities</a><ul>
-<li>
-<a href="#retrieving-an-entity">Retrieving 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="#parameters-2">Parameters</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-3">Parameters</a></li>
-</ul>
-</li>
-<li>
-<a href="#retrieving-multiple-entities">Retrieving multiple entities</a><ul>
-<li><a href="#example-requestresponse-6">Example Request/Response</a></li>
-<li><a href="#request-syntax-1">Request Syntax</a></li>
-<li><a href="#parameters-4">Parameters</a></li>
-<li><a href="#example-requestresponse-7">Example Request/Response</a></li>
-<li><a href="#sdk-method-5">SDK Method</a></li>
-<li><a href="#properties-2">Properties</a></li>
-<li><a href="#example-requestresponse-8">Example Request/Response</a></li>
-<li><a href="#sdk-method-6">SDK Method</a></li>
-<li><a href="#properties-3">Properties</a></li>
-<li><a href="#example-requestresponse-9">Example Request/Response</a></li>
-<li><a href="#sdk-method-7">SDK Method</a></li>
-<li><a href="#parameters-5">Parameters</a></li>
-<li><a href="#example-requestresponse-10">Example Request/Response</a></li>
-<li><a href="#sdk-method-8">SDK Method</a></li>
-<li><a href="#parameters-6">Parameters</a></li>
-<li><a href="#example-requestresponse-11">Example Request/Response</a></li>
-<li><a href="#sdk-method-9">SDK Method</a></li>
-<li><a href="#parameters-7">Parameters</a></li>
-</ul>
-</li>
-<li><a href="#add-new-comment">Add new comment</a></li>
-</ul>
-</li>
-</ul>
-</div>
-<h1 id="retrieving-data-entities">Retrieving Data Entities</h1>
-<p>This article describes how to retrieve entities from your Apache Usergrid account.</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>
-<p>With the exception of the <code>user</code> entity, all data entities can be retrieved by using their UUID or a ‘name’ property. The <code>user</code> entity can be retrieved by UUID or the ‘username’ property. The value for the ‘name’ or ‘username’ property must be unique.</p>
-<h2 id="retrieving-an-entity">Retrieving an entity</h2>
-<ul>
-<li><a href="#curl_get_entity">cURL</a></li>
-<li><a href="#ios_get_entity">iOS</a></li>
-<li><a href="#android_get_entity">Android</a></li>
-<li><a href="#javascript_get_entity">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_get_entity">Ruby</a></li>
-<li><a href="#nodejs_get_entity">Node.js</a></li>
-</ul>
-<h3 id="example-requestresponse">Example Request/Response</h3>
-<h4 id="request">Request:</h4>
-<p>Retrieve by UUID:</p>
-<pre><code>curl -X GET "https://api.usergrid.com/your-org/your-app/items/da4a50dc-38dc-11e2-b2e4-02e81adcf3d0"</code></pre>
-<p>Retrieve by ‘name’ property:</p>
-<pre><code>curl -X GET "https://api.usergrid.com/your-org/your-app/items/milk"</code></pre>
-<h4 id="response">Response:</h4>
-<pre><code>{
- "action" : "get",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/amuramoto/sandbox/items",
- "entities" : [ {
- "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
- "type" : "item",
- "name" : "milk",
- "created" : 1378405020796,
- "modified" : 1378405020796,
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "3.25"
- } ],
- "timestamp" : 1378405025763,
- "duration" : 31,
- "organization" : "amuramoto",
- "applicationName" : "sandbox"
-}</code></pre>
-<h3 id="request-syntax">Request Syntax</h3>
-<pre><code>curl -X GET https://api.usergrid.com/<org>/<app>/<collection>/<entity></code></pre>
-<h3 id="parameters">Parameters</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">Example Request/Response</h3>
-<h4 id="request-1">Request:</h4>
-<pre><code>-(NSString*)getEntity {
-
- //specify the entity collection and UUID or name to be retrieved
- NSString *endpoint = @"items/b3aad0a4-f322-11e2-a9c1-999e12039f87";
-
- NSString *query = nil;
-
- //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 getEntities:endpoint query:query];
-
- @try {
- //success
- }
-
- @catch (NSException * e) {
- //fail
- }
-
-}
- </code></pre>
-<h4 id="response-1">Response:</h4>
-<pre><code>{
- "action" : "get",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/amuramoto/sandbox/items",
- "entities" : [ {
- "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
- "type" : "item",
- "name" : "milk",
- "created" : 1378405020796,
- "modified" : 1378405020796,
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "3.25"
- } ],
- "timestamp" : 1378405025763,
- "duration" : 31,
- "organization" : "amuramoto",
- "applicationName" : "sandbox"
-}</code></pre>
-<h3 id="sdk-method">SDK Method</h3>
-<pre><code>(ApigeeClientResponse *)getEntities: (NSString *)endpoint query:(NSString *)query</code></pre>
-<h3 id="properties">Properties</h3>
-<table>
-<col width="50%">
-<col width="50%">
-<thead>
-<tr class="header">
-<th align="left">Parameter</th>
-<th align="left">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left"><p>endpoint</p></td>
-<td align="left">
-<p>The collection and entity identifier of the entity to be retrieved in the following format:</p>
-<pre><code><collection>/<entity_UUID_or_nam</code></pre>
-<p>e></p>
-</td>
-</tr>
-<tr class="even">
-<td align="left"><p>query</p></td>
-<td align="left"><p>An optional query string. Requests for a specific entity should set the value to <code>nil</code></p></td>
-</tr>
-</tbody>
-</table>
-<p><br> This example uses the <a href="/app-services-sdks#android">Apache Usergrid Android SDK</a>.</p>
-<h3 id="example-requestresponse-2">Example Request/Response</h3>
-<h4 id="request-2">Request:</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 query = "uuid = b3aad0a4-f322-11e2-a9c1-999e12039f87;
-
-//call getEntitiesAsync to initiate the asynchronous API call
-dataClient.getEntitiesAsync(type, query, new ApiResponseCallback() {
-
-//If getEntitiesAsync fails, catch the error
-@Override
-public void onException(Exception e) {
- // Error
-}
-
-//If createEntityAsync 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">Response:</h4>
-<pre><code>{
-"action":"post",
-"application":"f34f4222-a166-11e2-a7f7-02e81adcf3d0",
-"entities":[{
- "Client":{
- "accessToken":null,
- "apiUrl":"http://api.usergrid.com",
- "applicationId":"your-app",
- "clientId":null,
- "clientSecret":null,
- "currentOrganization":null,
- "loggedInUser":null,
- "organizationId":"your-org"
- },
- "type":"item",
- "uuid":"fd29157a-e980-11e2-afcc-652a12f1ce72",
- "created":1373475098695,
- "modified":1373475098695,
- "metadata":{
- "path":"/items/fd29157a-e980-11e2-afcc-652a12f1ce72"
- }
-}],
-
-"params":{},
-"path":"/items",
-"rawResponse":"{
- "action" : "get",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "fd29157a-e980-11e2-afcc-652a12f1ce72",
- "type" : "item",
- "created" : 1373475098695,
- "modified" : 1373475098695,
- "metadata" : {
- "path" : "/items/fd29157a-e980-11e2-afcc-652a12f1ce72"
- }
- } ],
- "timestamp" : 1373475098689,
- "duration" : 24,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}",
-"uri":"http://api.usergrid.com/your-org/your-app/items",
-"timestamp":1373475098689,
-"entityCount":1,
-"firstEntity":{
- "Client":{
- "accessToken":null,
- "apiUrl":"http://api.usergrid.com",
- "applicationId":"your-app",
- "clientId":null,
- "clientSecret":null,
- "currentOrganization":null,
- "loggedInUser":null,
- "organizationId":"your-org"
- },
- "type":"item",
- "uuid":"fd29157a-e980-11e2-afcc-652a12f1ce72",
- "created":1373475098695,
- "modified":1373475098695,
- "metadata":{
- "path":"/items/fd29157a-e980-11e2-afcc-652a12f1ce72"
- }
-},
-"lastEntity":{
- "Client":{
- "accessToken":null,
- "apiUrl":"http://api.usergrid.com",
- "applicationId":"your-app",
- "clientId":null,
- "clientSecret":null,
- "currentOrganization":null,
- "loggedInUser":null,
- "organizationId":"your-org"
- },
- "type":"item",
- "uuid":"fd29157a-e980-11e2-afcc-652a12f1ce72",
- "created":1373475098695,
- "modified":1373475098695,
- "metadata":{
- "path":"/items/fd29157a-e980-11e2-afcc-652a12f1ce72"
- }
-},
-"organization":"your-org",
-"duration":24,
-"applicationName":"your-app"
-}
- </code></pre>
-<h3 id="sdk-method-1">SDK Method</h3>
-<p>Asynchronous:</p>
-<pre><code>getEntitiesAsync(String type, String queryString, ApiResponseCallback callback)</code></pre>
-<p>Synchronous:</p>
-<pre><code>ApiResponse getEntities(String type, String queryString)</code></pre>
-<h3 id="properties-1">Properties</h3>
-<table>
-<col width="50%">
-<col width="50%">
-<thead>
-<tr class="header">
-<th align="left">Parameter</th>
-<th align="left">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left"><p>type</p></td>
-<td align="left"><p>The entity type being retrieved</p></td>
-</tr>
-<tr class="even">
-<td align="left"><p>queryString</p></td>
-<td align="left">
-<p>A query string that specifies the property of the entity to be retrieved in the following format:</p>
-<pre><code><property>=<value></code></pre>
-<p>To retrieve a specific entity, use the unique entity <em>uuid</em> or <em>name</em> property.</p>
-</td>
-</tr>
-<tr class="odd">
-<td align="left"><p>callback</p></td>
-<td align="left"><p>Callback function (Asynchronous calls only)</p></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">Example Request/Response</h3>
-<h4 id="request-3">Request:</h4>
-<pre><code>var properties = {
- 'type':'item',
- 'name':'milk' //This method also supports retrieval by uuid
-};
-
-client.getEntity(properties, function (error, response) {
- if (err) {
- //error
- } else {
- //success
- }
-});
- </code></pre>
-<h4 id="response-3">Response:</h4>
-<pre><code>Usergrid.Entity {_client: Usergrid.Client, _data: Object, serialize: function, get: function, set: function…}
- _client: Usergrid.Client
- URI: "https://api.usergrid.com"
- _callTimeout: 30000
- _callTimeoutCallback: null
- _end: 1378413997721
- _start: 1378413997493
- appName: "your-app"
- buildCurl: false
- logging: true
- logoutCallback: null
- orgName: "your-org"
- __proto__: Object
- _data: Object
- created: 1378405020796
- metadata: Object
- modified: 1378405020796
- name: "milk"
- price: "3.25"
- type: "item"
- uuid: "5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- __proto__: Object
- __proto__: Object
- </code></pre>
-<h3 id="sdk-method-2">SDK Method</h3>
-<pre><code>getEntity(properties, callback)</code></pre>
-<h3 id="parameters-1">Parameters</h3>
-<h4 id="getentity">getEntity():</h4>
-<table>
-<col width="50%">
-<col width="50%">
-<thead>
-<tr class="header">
-<th align="left">Parameter</th>
-<th align="left">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left"><p>properties</p></td>
-<td align="left">
-<p>Object that contains the following properties of the entity to be retrieved:</p>
-<ul>
-<li>type: the entity type to be retrieved</li>
-<li>name: the name of the entity to be retrieved</li>
-<li>uuid: the uuid of the entity to be retrieved</li>
-</ul>
-<p>You only need to specify name or uuid, not both.</p>
-</td>
-</tr>
-<tr class="even">
-<td align="left"><p>callback</p></td>
-<td align="left"><p>Callback function</p></td>
-</tr>
-</tbody>
-</table>
-<p>This example uses the <a href="/app-services-sdks#ruby">Apache Usergrid RubyGem</a>.</p>
-<h3 id="example-requestresponse-4">Example Request/Response</h3>
-<h4 id="request-4">Request:</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
-# Retrieve the entity by referencing the [type] and [uuid or name]
-# and save the response
-response = client['items']['milk'].entity
-
-rescue
-#fail
-end
- </code></pre>
-<h4 id="response-4">Response:</h4>
-<pre><code>{
- "action" : "get",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/amuramoto/sandbox/items",
- "entities" : [ {
- "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
- "type" : "item",
- "name" : "milk",
- "created" : 1378405020796,
- "modified" : 1378405020796,
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "3.25"
- } ],
- "timestamp" : 1378405025763,
- "duration" : 31,
- "organization" : "amuramoto",
- "applicationName" : "sandbox"
-}</code></pre>
-<h3 id="sdk-method-3">SDK Method</h3>
-<pre><code>application[<entity_type>][<entity_uuid|entity_name>].entity</code></pre>
-<h3 id="parameters-2">Parameters</h3>
-<p>Parameter</p>
-<p>Description</p>
-<p>entity_type</p>
-<p>The entity type to be retrieved</p>
-<p>entity_uuid|entity_name</p>
-<p>The name or UUID of the entity to be retrieved</p>
-<p>This example uses the <a href="/app-services-sdks#nodejs">Apache Usergrid Node.js module</a>.</p>
-<h3 id="example-requestresponse-5">Example Request/Response</h3>
-<h4 id="request-5">Request:</h4>
-<pre><code>var properties = {
- method:'GET',
- type:'items',
- name:'da4a50dc-38dc-11e2-b2e4-02e81adcf3d0'
-};
-
-client.getEntity(properties, function (error, response) {
- if (error) {
- //error
- } else {
- //success
- }
-});
- </code></pre>
-<h4 id="response-5">Response:</h4>
-<pre><code>{ _client:
- { URI: 'https://api.usergrid.com',
- orgName: 'your-org',
- appName: 'your-app',
- authType: 'NONE',
- clientId: undefined,
- clientSecret: undefined,
- token: null,
- buildCurl: false,
- logging: true,
- _callTimeout: 30000,
- _callTimeoutCallback: null,
- logoutCallback: null,
- _start: 1378423148601,
- _end: 1378423149028 },
- _data:
- { method: 'GET',
- type: 'item',
- name: 'milk',
- uuid: '5bb76bca-1657-11e3-903f-9ff6c621a7a4',
- created: 1378405020796,
- modified: 1378405020796,
- metadata: { path: '/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4' },
- price: '3.25' } }
- </code></pre>
-<h3 id="sdk-method-4">SDK Method</h3>
-<pre><code>getEntity(properties, callback)</code></pre>
-<h3 id="parameters-3">Parameters</h3>
-<p>Parameter</p>
-<p>Description</p>
-<p>Object that contains the following properties of the entity to be retrieved:</p>
-<ul>
-<li>type: the entity type to be retrieved</li>
-<li>name: the name of the entity to be retrieved</li>
-<li>uuid: the uuid of the entity to be retrieved</li>
-</ul>
-<p>You only need to specify name or uuid, not both.</p>
-<p>callback</p>
-<p>Callback function</p>
-<h2 id="retrieving-multiple-entities">Retrieving multiple entities</h2>
-<ul>
-<li><a href="#curl_get_multentity">cURL</a></li>
-<li><a href="#ios_get_multentity">iOS</a></li>
-<li><a href="#android_get_multentity">Android</a></li>
-<li><a href="#javascript_get_multentity">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_get_multentity">Ruby</a></li>
-<li><a href="#nodejs_get_multentity">Node.js</a></li>
-</ul>
-<p>This example describes how to retrieve multiple entities by UUID. You can also retrieve a set of entities by using a query string. For more information on querying your data, see <a href="/basic-query-syntax">Basic query syntax</a>.</p>
-<h3 id="example-requestresponse-6">Example Request/Response</h3>
-<h4 id="request-6">Request:</h4>
-<pre><code>//note the url-encoded query string
-curl -X GET "https://api.usergrid.com/your-org/your-app/items?ql=name%3D'milk'%20OR%20UUID%3D1a9356ba-1682-11e3-a72a-81581bbaf055&limit="
- </code></pre>
-<p><strong>Note:</strong> The query parameter of the request must be url encoded for curl requests</p>
-<h4 id="response-6">Response:</h4>
-<pre><code>{
- "action" : "get",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : {
- "ql" : [ "name='milk' OR UUID=1a9356ba-1682-11e3-a72a-81581bbaf055" ]
- },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
- "type" : "item",
- "name" : "milk",
- "created" : 1378405020796,
- "modified" : 1378405020796,
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "3.25"
- }, {
- "uuid" : "1a9356ba-1682-11e3-a72a-81581bbaf055",
- "type" : "item",
- "name" : "bread",
- "created" : 1378423379867,
- "modified" : 1378423379867,
- "metadata" : {
- "path" : "/items/1a9356ba-1682-11e3-a72a-81581bbaf055"
- },
- "name" : "bread",
- "price" : "2.50"
- } ],
- "timestamp" : 1378423793729,
- "duration" : 63,
- "organization" : "your-org",
- "applicationName" : "your-app",
- "count" : 2
-}</code></pre>
-<h3 id="request-syntax-1">Request Syntax</h3>
-<pre><code>curl -X GET https://api.usergrid.com/<org_id>/<app_id>/<collection>?ql= uuid = <entity_uuid> OR uuid = <entity_uuid>; ...</code></pre>
-<h3 id="parameters-4">Parameters</h3>
-<table>
-<col width="50%">
-<col width="50%">
-<thead>
-<tr class="header">
-<th align="left">Parameter</th>
-<th align="left">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left"><p>org_id</p></td>
-<td align="left"><p>Organization UUID or organization name</p></td>
-</tr>
-<tr class="even">
-<td align="left"><p>app_id</p></td>
-<td align="left"><p>Application UUID or application name</p></td>
-</tr>
-<tr class="odd">
-<td align="left"><p>collection</p></td>
-<td align="left"><p>Collection UUID or collection name</p></td>
-</tr>
-<tr class="even">
-<td align="left"><p>query</p></td>
-<td align="left">
-<p>A url-encoded query string of entity properties to be matched in the following format:</p>
-<pre><code>?ql=uuid="<entity_uuid>"" OR nam</code></pre>
-<p>e=“<entity_name>” OR…</entity_name></p>
-<p>You may also specify the following for certain entity types:</p>
-<p>User entities: <code>username = <entity_username></code></p>
-<p>All other entities except groups: <code>name = <entity_name></code></p>
-</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-7">Example Request/Response</h3>
-<h4 id="request-7">Request:</h4>
-<pre><code>-(NSString*)getEntity {
-
-//specify the entity type to be retrieved
-NSString *type = @"item";
-
-//specify the uuid of the entity to be retrieved in a query string
-NSString *query = @"uuid = b3aad0a4-f322-11e2-a9c1-999e12039f87 or name = 'bread'";
-
- //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 getEntities:type queryString:query];
-
-@try {
- //success
-}
-@catch (NSException * e) {
- //fail
-}
-
-}
-
- </code></pre>
-<h4 id="response-7">Response:</h4>
-<pre><code>{
- "action" : "get",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : {
- "ql" : [ "name='milk' OR UUID=1a9356ba-1682-11e3-a72a-81581bbaf055" ]
- },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
- "type" : "item",
- "name" : "milk",
- "created" : 1378405020796,
- "modified" : 1378405020796,
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "3.25"
- }, {
- "uuid" : "1a9356ba-1682-11e3-a72a-81581bbaf055",
- "type" : "item",
- "name" : "bread",
- "created" : 1378423379867,
- "modified" : 1378423379867,
- "metadata" : {
- "path" : "/items/1a9356ba-1682-11e3-a72a-81581bbaf055"
- },
- "name" : "bread",
- "price" : "2.50"
- } ],
- "timestamp" : 1378423793729,
- "duration" : 63,
- "organization" : "your-org",
- "applicationName" : "your-app",
- "count" : 2
-}</code></pre>
-<h3 id="sdk-method-5">SDK Method</h3>
-<pre><code>(ApigeeClientResponse *)getEntities: (NSString *)type queryString:(NSString *)queryString</code></pre>
-<h3 id="properties-2">Properties</h3>
-<table>
-<col width="50%">
-<col width="50%">
-<thead>
-<tr class="header">
-<th align="left">Parameter</th>
-<th align="left">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left"><p>type</p></td>
-<td align="left"><p>The entity type being retrieved</p></td>
-</tr>
-<tr class="even">
-<td align="left"><p>queryString</p></td>
-<td align="left"><p>A query string of entity properties to be matched for the entities to be retrieved in the following format: <property>=<value> OR <property> =<value> OR …</value></property></value></property></p></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-8">Example Request/Response</h3>
-<h4 id="request-8">Request:</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 query = "uuid = f8726dda-f54a-11e2-b560-575bef89aaed OR name = 'bread'"; //query string specifying the entities to be retrieved
-
-
-//call getEntitiesAsync to initiate the asynchronous API call
-dataClient.getEntitiesAsync(type, query, new ApiResponseCallback() {
-
-//If getEntitiesAsync fails, catch the error
-@Override
-public void onException(Exception e) {
- // Error
-}
-
-//If createEntityAsync 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-8">Response:</h4>
-<pre><code>{"action":"get","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":"5bb76bca-1657-11e3-903f-9ff6c621a7a4","price":"3.25","created":1378405020796,"name":"milk","modified":1378405020796,"metadata":{"path":"/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"}},{"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":"1a9356ba-1682-11e3-a72a-81581bbaf055","price":"2.50","created":1378423379867,"name":"bread","modified":1378423379867,"metadata":{"path":"/items/1a9356ba-1682-11e3-a72a-81581bbaf055"}}],"params":{"ql":["uuid = 5bb76bca-1657-11e3-903f-9ff6c621a7a4 OR name = 'bre
ad'"]},"path":"/items","rawResponse":"{
- "action" : "get",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : {
- "ql" : [ "uuid = 5bb76bca-1657-11e3-903f-9ff6c621a7a4 OR name = 'bread'" ]
- },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
- "type" : "item",
- "name" : "milk",
- "created" : 1378405020796,
- "modified" : 1378405020796,
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "3.25"
- }, {
- "uuid" : "1a9356ba-1682-11e3-a72a-81581bbaf055",
- "type" : "item",
- "name" : "bread",
- "created" : 1378423379867,
- "modified" : 1378423379867,
- "metadata" : {
- "path" : "/items/1a9356ba-1682-11e3-a72a-81581bbaf055"
- },
- "name" : "bread",
- "price" : "2.50"
- } ],
- "timestamp" : 1378425390343,
- "duration" : 42,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}
-","uri":"http://api.usergrid.com/your-org/your-app/items","timestamp":1378425390343,"entityCount":2,"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":"5bb76bca-1657-11e3-903f-9ff6c621a7a4","price":"3.25","created":1378405020796,"name":"milk","modified":1378405020796,"metadata":{"path":"/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"}},"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":"1a9356ba-1682-11e3-a72a-81581bbaf055","price":"2.50","created":1378423379867,"name":"bread","modified":1378423379867,"metadata":{"path":"/items/1a9356ba-1682-11e3-a72a-81581bbaf055"}},"organization":"your-org","duration":42,"
applicationName":"your-app"}
- </code></pre>
-<h3 id="sdk-method-6">SDK Method</h3>
-<p>Asynchronous:</p>
-<pre><code>getEntitiesAsync(String type, String queryString, ApiResponseCallback callback)</code></pre>
-<p>Synchronous:</p>
-<pre><code>ApiResponse getEntities(String type, String queryString)</code></pre>
-<h3 id="properties-3">Properties</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 retrieved</td>
-</tr>
-<tr class="even">
-<td align="left">queryString</td>
-<td align="left">A query string of entity properties to be matched for the entities to be retrieved in the following format: <property>=<value> OR <property>=<value> OR …</td>
-</tr>
-<tr class="odd">
-<td align="left">callback</td>
-<td align="left">Callback function (Asynchronous calls only)</td>
-</tr>
-</tbody>
-</table>
-<p>This example uses the <a href="/app-services-sdks#javascript">Apache Usergrid JavaScript (HTML5) module</a>.</p>
-<h3 id="example-requestresponse-9">Example Request/Response</h3>
-<h4 id="request-9">Request:</h4>
-<pre><code>var dataClient = new Usergrid.Client({
-orgName:'your-org',
-appName:'your-app'
-});
-
-var options = {
- endpoint:"items",
- //Define the query - note the use of the 'ql' property
- //Note the use of the single-quote for the string 'bread'
- qs:{ql:"name='bread' or uuid=b3aad0a4-f322-11e2-a9c1-999e12039f87"}
- };
-
-//Call request to initiate the API call
-dataClient.request(options, function (error, response) {
-if (err) {
- //error — GET failed
-} else {
- //success
-}
-});
- </code></pre>
-<h4 id="response-9">Response:</h4>
-<pre><code>Object {action: "get", application: "f34f4222-a166-11e2-a7f7-02e81adcf3d0", params: Object, path: "/items", uri: "http://api.usergrid.com/your-org/your-app/items"…}
- action: "get"
- application: "f34f4222-a166-11e2-a7f7-02e81adcf3d0"
- applicationName: "your-app"
- count: 2
- duration: 57
- entities: Array[2]
- 0: Object
- created: 1378423379867
- metadata: Object
- modified: 1378423379867
- name: "bread"
- price: "2.50"
- type: "item"
- uuid: "1a9356ba-1682-11e3-a72a-81581bbaf055"
- __proto__: Object
- 1: Object
- created: 1378405020796
- metadata: Object
- modified: 1378405020796
- name: "milk"
- price: "3.25"
- type: "item"
- uuid: "5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- __proto__: Object
- length: 2
- __proto__: Array[0]
- organization: "your-org"
- params: Object
- path: "/items"
- timestamp: 1378426195611
- uri: "http://api.usergrid.com/your-org/your-app/items"
- __proto__: Object
- </code></pre>
-<h3 id="sdk-method-7">SDK Method</h3>
-<pre><code>request(properties,callback)</code></pre>
-<h3 id="parameters-5">Parameters</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">properties</td>
-<td align="left">Object that contains the entity properties</td>
-</tr>
-<tr class="even">
-<td align="left">callback</td>
-<td align="left">Callback function</td>
-</tr>
-</tbody>
-</table>
-<p>This example uses the <a href="/app-services-sdks#ruby">Apache Usergrid RubyGem</a>.</p>
-<h3 id="example-requestresponse-10">Example Request/Response</h3>
-<h4 id="request-10">Request:</h4>
-<p>This example uses the <a href="/app-services-sdks#ruby">Apache Usergrid RubyGem</a>.</p>
-<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
-
-# Specify the name or uuid of the collection that contains them, and a query the specifies the name or uuid of the entities to retrieve
-response = client['items'].query("uuid=a86e614a-efc8-11e2-94fb-a94a8e3669a7 or uuid=71c29a2a-efc9-11e2-a3cc-ed942506cf87").entity
-
-rescue
-#fail
-end
- </code></pre>
-<h4 id="response-10">Response:</h4>
-<pre><code>{
- "action" : "get",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : {
- "ql" : [ "name='milk' OR UUID=1a9356ba-1682-11e3-a72a-81581bbaf055" ]
- },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "5bb76bca-1657-11e3-903f-9ff6c621a7a4",
- "type" : "item",
- "name" : "milk",
- "created" : 1378405020796,
- "modified" : 1378405020796,
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "3.25"
- }, {
- "uuid" : "1a9356ba-1682-11e3-a72a-81581bbaf055",
- "type" : "item",
- "name" : "bread",
- "created" : 1378423379867,
- "modified" : 1378423379867,
- "metadata" : {
- "path" : "/items/1a9356ba-1682-11e3-a72a-81581bbaf055"
- },
- "name" : "bread",
- "price" : "2.50"
- } ],
- "timestamp" : 1378423793729,
- "duration" : 63,
- "organization" : "your-org",
- "applicationName" : "your-app",
- "count" : 2
-}</code></pre>
-<h3 id="sdk-method-8">SDK Method</h3>
-<pre><code>Application.[<collection>].query(<query>)</code></pre>
-<h3 id="parameters-6">Parameters</h3>
-<table>
-<col width="50%">
-<col width="50%">
-<thead>
-<tr class="header">
-<th align="left">Parameter</th>
-<th align="left">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left"><p>collection</p></td>
-<td align="left"><p>The name or uuid of the collection that contains the data entities to be retrieved</p></td>
-</tr>
-<tr class="even">
-<td align="left"><p>query</p></td>
-<td align="left">
-<p>A query string that specifies the property of the entity to be retrieved in the following format: <property>=<value></value></property></p>
-<p>To retrieve a specific entity, use the unique entity <em>uuid</em> or <em>name</em> property.</p>
-</td>
-</tr>
-</tbody>
-</table>
-<p>This example uses the <a href="/app-services-sdks#nodejs">Apache Usergrid Node.js module</a>.</p>
-<h3 id="example-requestresponse-11">Example Request/Response</h3>
-<h4 id="request-11">Request:</h4>
-<pre><code>var dataClient = new Usergrid.client({
-orgName:'your-org',
-appName:'your-app'
-});
-
-var options = {
- endpoint:"items",
- //Define the query - note the use of the 'ql' property
- //Note the use of the single-quote for the string 'bread'
- qs:{ql:"name='bread' or uuid=b3aad0a4-f322-11e2-a9c1-999e12039f87"}
- };
-
-//Call request to initiate the API call
-dataClient.request(options, function (error, response) {
- if (error) {
- //error — GET failed
- } else {
- //success
- }
-});
- </code></pre>
-<h4 id="response-11">Response:</h4>
-<pre><code>{ action: 'get',
- application: 'f34f4222-a166-11e2-a7f7-02e81adcf3d0',
- params: { ql: [ 'name=\'bread\' or uuid=5bb76bca-1657-11e3-903f-9ff6c621a7a4' ] },
- path: '/items',
- uri: 'http://api.usergrid.com/your-org/your-app/items',
- entities:
- [ { uuid: '1a9356ba-1682-11e3-a72a-81581bbaf055',
- type: 'item',
- name: 'bread',
- created: 1378423379867,
- modified: 1378423379867,
- metadata: [Object],
- price: '2.50' },
- { uuid: '5bb76bca-1657-11e3-903f-9ff6c621a7a4',
- type: 'item',
- name: 'milk',
- created: 1378405020796,
- modified: 1378405020796,
- metadata: [Object],
- price: '3.25' } ],
- timestamp: 1378426688958,
- duration: 37,
- organization: 'your-org',
- applicationName: 'your-app',
- count: 2 }
- </code></pre>
-<h3 id="sdk-method-9">SDK Method</h3>
-<pre><code>request(properties,callback)</code></pre>
-<h3 id="parameters-7">Parameters</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">properties</td>
-<td align="left">Object that contains the entity properties</td>
-</tr>
-<tr class="even">
-<td align="left">callback</td>
-<td align="left">Callback function</td>
-</tr>
-</tbody>
-</table>
-<h2 id="add-new-comment">Add new comment</h2>
-<p>Your name</p>
-<p>Email</p>
-<p>Provide your email address if you wish to be contacted offline about your comment.<br>We will not display your email address as part of your comment.</p>
-<p>Comment *</p>
-<p>We’d love your feedback and perspective! Please be as specific as possible.</p>
-<p>Word verification *</p>
-<p><img src="http://173.193.242.189:80/v1/captcha/131019a6363a732611.png" alt="Type the characters you see in this picture."> (<a href="#">verify using audio</a>)</p>
-<p>Type the characters you see in the picture above; if you can’t read them, submit the form and a new image will be generated. Not case sensitive.</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="/community">ask on the mailing-lists</a>!<br/>
- <!--
- <strong>Found an error?</strong> We’d greatly appreciate a pull request about <a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/retrieving-data-entities.md">this article on github</a>.</div>
- -->
- </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>
- </ul>
- </div>
- <div class="col-md-2">
- <ul class="nav nav-list">
- <li class="nav-header"><a href="https://github.com/apache/incubator-usergrid/" target="_blank">Code</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
- <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
- <li><a href="https://github.com/apache/incubator-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/apache/incubator-usergrid" target="_blank">GitHub Code</a></li>
- <li><a href="http://usergrid.readthedocs.org/" target="_blank">Docs</a></li>
- <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible" target="_blank">JIRA Bug Tracker</a></li>
- <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
- <li><a href="/community/#live">Live Chat</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/apache/incubator-usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
- <li><a href="https://cwiki.apache.org/confluence/display/usergrid/GitHub+Based+Contribution+Workflow" target="_blank">Contribution Guidelines</a></li>
- </ul>
- </div>
- <div class="col-md-2">
- <ul class="nav nav-list">
- <li class="nav-header">Apache</li>
- <li><a href="http://www.apache.org/licenses/" target="_blank">License</a></li>
- <li><a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">Sponsorship</a></li>
- <li><a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a></li>
- <li><a href="http://www.apache.org/security/">Security</a></li>
- <li><a href="http://www.apache.org/" target="_blank">Apache Foundation</a></li>
- </ul>
- </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 Apache Incubator PMC. 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>
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
- ga('create', 'UA-45815079-1', 'apache.org');
- ga('send', 'pageview');
-
-</script>
-
-
-
-</body>
-</html>