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:42 UTC
[17/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/updating-collections/index.html
----------------------------------------------------------------------
diff --git a/website/publish/docs/updating-collections/index.html b/website/publish/docs/updating-collections/index.html
deleted file mode 100644
index 3ac17b7..0000000
--- a/website/publish/docs/updating-collections/index.html
+++ /dev/null
@@ -1,706 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
- <meta charset="utf-8">
- <title>Apache Usergrid (incubating) — Updating Collections</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>Updating Collections</h1>
- <!-- TODO: reenable this when we sync SVN to GitHub
- <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/updating-collections.md">contribute to this article on github</a></small>
- -->
- </div>
- <div class="toc">
- <ul>
-<li>
-<a href="#updating-collections">Updating Collections</a><ul>
-<li>
-<a href="#batch-updating-entities-in-a-collection">Batch updating entities in a collection</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="#parameters-1">Parameters</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="#properties-1">Properties</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>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</div>
-<h1 id="updating-collections">Updating Collections</h1>
-<p>This article describes how to perform batch updates on all entities in a collection. Batch updates require the use of a query string in the request, which can either specify all entities in the collection or a subset of entities for the update to be performed on. For more information on queries, see <a href="/basic-query-syntax">Basic query syntax</a>.</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="batch-updating-entities-in-a-collection">Batch updating entities in a collection</h2>
-<ul>
-<li><a href="#curl_update_collection">cURL</a></li>
-<li><a href="#ios_update_collection">iOS</a></li>
-<li><a href="#android_update_collection">Android</a></li>
-<li><a href="#javascript_update_collection">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_update_collection">Ruby</a></li>
-<li><a href="#nodejs_update_collection">Node.js</a></li>
-</ul>
-<h3 id="example-requestresponse">Example Request/Response</h3>
-<h4 id="request">Request:</h4>
-<pre><code>curl -X PUT https://api.usergrid.com/your-org/your-app/items/?ql= -d '{"availability":"in-stock"}'</code></pre>
-<p>Note the empty <code>?ql=</code> query string.</p>
-<h4 id="response">Response:</h4>
-<pre><code>{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : {
- "ql" : [ "" ]
- },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "31847b9a-1a62-11e3-be04-8d05e96f700d",
- "type" : "item",
- "name" : "milk",
- "price" : "3.25",
- "availability" : "in-stock"
- "created" : 1378849479113,
- "modified" : 1378849567301,
- "name" : "milk",
- }, {
- "uuid" : "3192ac6a-1a62-11e3-a24f-496ca1d42ce7",
- "type" : "item",
- "name" : "bread",
- "price" : "4.00",
- "availability" : "in-stock"
- "created" : 1378849479206,
- "modified" : 1378849567351,
- "name" : "bread",
- } ],
- "timestamp" : 1378849567280,
- "duration" : 207,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}</code></pre>
-<h3 id="request-syntax">Request Syntax</h3>
-<pre><code>curl -X PUT https://api.usergrid.com/<org>/<app>/<collection>/?ql= -d {<property>}</code></pre>
-<p>Note the empty query string (ql=) appended to the URL.</p>
-<h3 id="parameters">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</p></td>
-<td align="left"><p>Organization UUID or organization name</p></td>
-</tr>
-<tr class="even">
-<td align="left"><p>app</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>property</p></td>
-<td align="left">
-<p>An entity property to be updated, formatted as a key-value pair. For example:</p>
-<pre><code>{"property_1":"value_1", "proper</code></pre>
-<p>ty_2“:”value_2“,…}</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-1">Example Request/Response</h3>
-<h4 id="request-1">Request:</h4>
-<pre><code>-(NSString*)updateCollection {
-
- NSString *url = @"https://api.usergrid.com/your-org/your-app/items/?ql";
- NSString *op = @"PUT";
- NSString *opData = @"{\"availability\":\"in-stock\"}"; //we escape the quotes
-
- //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 apiRequest: url operation: op data: opData];
-
- @try {
- //success
- }
- @catch (NSException * e) {
- //fail
- }
-
-}
- </code></pre>
-<h4 id="response-1">Response:</h4>
-<pre><code>{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : {
- "ql" : [ "" ]
- },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "31847b9a-1a62-11e3-be04-8d05e96f700d",
- "type" : "item",
- "name" : "milk",
- "price" : "3.25",
- "availability" : "in-stock"
- "created" : 1378849479113,
- "modified" : 1378849567301,
- "name" : "milk",
- }, {
- "uuid" : "3192ac6a-1a62-11e3-a24f-496ca1d42ce7",
- "type" : "item",
- "name" : "bread",
- "price" : "4.00",
- "availability" : "in-stock"
- "created" : 1378849479206,
- "modified" : 1378849567351,
- "name" : "bread",
- } ],
- "timestamp" : 1378849567280,
- "duration" : 207,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}</code></pre>
-<h3 id="sdk-method">SDK Method</h3>
-<pre><code>(ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData</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>url</p></td>
-<td align="left">
-<p>A fully-formed request url in the following format: https://api.usergrid.com/<org>/< app>/<collection>/?ql=</collection></org></p>
-<p>Note that you must include an empty ‘?ql=’ query string at the end of the URL</p>
-</td>
-</tr>
-<tr class="even">
-<td align="left"><p>op</p></td>
-<td align="left"><p>The HTTP method - in this case, ‘PUT’</p></td>
-</tr>
-<tr class="odd">
-<td align="left"><p>opData</p></td>
-<td align="left"><p>A JSON-formatted string that contains the entity properties to be updated</p></td>
-</tr>
-</tbody>
-</table>
-<p>Updating all entities in a collection is not currently supported by the <a href="/app-services-sdks#android">Apache Usergrid Android SDK</a>.</p>
-<p>This example uses the <a href="/app-services-sdks#javascript">Apache Usergrid JavaScript (HTML5) SDK</a>.</p>
-<h3 id="example-requestresponse-2">Example Request/Response</h3>
-<h4 id="request-2">Request:</h4>
-<pre><code>//create the basic client object
-var dataClient = new Usergrid.Client({
- orgName:'your-org',
- appName:'your-app'
-});
-
-//options for the request
-var options = {
- endpoint:"items/?ql=", //don't forget to append '/?ql='
- method:"PUT",
- body: {"availability":"in-stock"}
-}
-
-dataClient.request(options,function (error,response) {
-
- if (error) {
- // Error
- } else {
- // Success
- }
-
-});
- </code></pre>
-<h4 id="response-2">Response:</h4>
-<pre><code>Object {action: "put", application: "f34f4222-a166-11e2-a7f7-02e81adcf3d0", params: Object, path: "/items", uri: "http://api.usergrid.com/your-org/your-app/items"…}
-action: "put"
-application: "f34f4222-a166-11e2-a7f7-02e81adcf3d0"
-applicationName: "your-app"
-duration: 92
-entities: Array[2]
- 0: Object
- availability: "in-stock"
- created: 1378852309294
- modified: 1378853303215
- name: "milk"
- price: "3.25"
- type: "item"
- uuid: "c86ffbf0-1a68-11e3-ab22-3713e5fcf9d2"
- __proto__: Object
- 1: Object
- availability: "in-stock"
- created: 1378852309373
- modified: 1378853303256
- name: "bread"
- price: "4.00"
- type: "item"
- uuid: "c87be2da-1a68-11e3-80f4-975f1f8b1f86"
- __proto__: Object
- length: 2
- __proto__: Array[0]
-organization: "your-org"
-params: Object
-path: "/items"
-timestamp: 1378853303201
-uri: "http://api.usergrid.com/your-org/your-app/items"
-__proto__: Object
- </code></pre>
-<h3 id="sdk-method-1">SDK Method</h3>
-<pre><code>request(options, callback)</code></pre>
-<h3 id="parameters-1">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>options</p></td>
-<td align="left">
-<p>A JSON-formatted object containing the following properties:</p>
-<ul>
-<li>endpoint: the UUID or name of the collection to be updated, appended by an empty query string in the format: <collection>/?ql=</li>
-<li>method: the HTTP method for the request – in this case <code>PUT</code>
-</li>
-<li>body: the body of the request that specifies the properties to be updated in JSON format</li>
-</ul>
-</td>
-</tr>
-<tr class="even">
-<td align="left"><p>callback</p></td>
-<td align="left"><p>Callback function to handle the API response</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-3">Example Request/Response</h3>
-<h4 id="request-3">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
- collection = client['items'].collection
- collection.update_query({availability: 'in-stock'},"")
-rescue
- #fail
-end
- </code></pre>
-<h4 id="response-3">Response:</h4>
-<pre><code>{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : {
- "ql" : [ "" ]
- },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "31847b9a-1a62-11e3-be04-8d05e96f700d",
- "type" : "item",
- "name" : "milk",
- "price" : "3.25",
- "availability" : "in-stock"
- "created" : 1378849479113,
- "modified" : 1378849567301,
- "name" : "milk",
- }, {
- "uuid" : "3192ac6a-1a62-11e3-a24f-496ca1d42ce7",
- "type" : "item",
- "name" : "bread",
- "price" : "4.00",
- "availability" : "in-stock"
- "created" : 1378849479206,
- "modified" : 1378849567351,
- "name" : "bread",
- } ],
- "timestamp" : 1378849567280,
- "duration" : 207,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}</code></pre>
-<h3 id="sdk-method-2">SDK Method</h3>
-<pre><code>collection.update_query(properties, query_string)</code></pre>
-<h3 id="properties-1">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">properties</td>
-<td align="left">JSON-formatted string that contains the entity properties to be updated</td>
-</tr>
-<tr class="even">
-<td align="left">query_string</td>
-<td align="left">A query string that specifies the entities to be updated. Use an empty string (<code>""</code>) to update all entities.</td>
-</tr>
-</tbody>
-</table>
-<p>The example assumes use of the <a href="/app-services-sdks#nodejs">Apache Usergrid Node.js module</a>.</p>
-<h3 id="example-requestresponse-4">Example Request/Response</h3>
-<h4 id="request-4">Request:</h4>
-<pre><code>//Create the Apache Usergrid client object
-var dataClient = new Usergrid.client({
- orgName:'your-org',
- appName:'your-app'
-});
-
-//Specify the options for the request
-var options = {
- endpoint:"items/?ql=", //don't forget to append '/?ql='
- method:"PUT",
- body: {"availability":"in-stock"}
-}
-
-dataClient.request(options,function (error,response) {
-
- if (error) {
- //error
- } else {
- //success
- }
-
-});
- </code></pre>
-<h4 id="response-4">Response:</h4>
-<pre><code>{ action: 'put',
- application: 'f34f4222-a166-11e2-a7f7-02e81adcf3d0',
- params: { ql: [ '' ] },
- path: '/items',
- uri: 'http://api.usergrid.com/your-org/your-app/items',
- entities:
- [ { uuid: 'c86ffbf0-1a68-11e3-ab22-3713e5fcf9d2',
- type: 'item',
- name: 'milk',
- created: 1378852309294,
- modified: 1378855073613,
- availability: 'in-stock' },
- { uuid: 'c87be2da-1a68-11e3-80f4-975f1f8b1f86',
- type: 'item',
- name: 'bread',
- created: 1378852309373,
- modified: 1378855073655,
- availability: 'in-stock' } ],
- timestamp: 1378855073595,
- duration: 106,
- organization: 'your-org',
- applicationName: 'your-app' }
- </code></pre>
-<h3 id="sdk-method-3">SDK Method</h3>
-<pre><code>request(options,callback);</code></pre>
-<h3 id="parameters-2">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>options</p></td>
-<td align="left">
-<p>A JSON-formatted object containing the following properties:</p>
-<ul>
-<li>endpoint: the UUID or name of the collection to be updated, appended by an empty query string in the format: <collection>/?ql=</li>
-<li>method: the HTTP method for the request, in this case <em>PUT</em>
-</li>
-</ul>
-</td>
-</tr>
-<tr class="even">
-<td align="left"><p>callback</p></td>
-<td align="left"><p>Callback function to handle the API response</p></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="/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/updating-collections.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>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/ec2b3e4f/website/publish/docs/updating-data-entities/index.html
----------------------------------------------------------------------
diff --git a/website/publish/docs/updating-data-entities/index.html b/website/publish/docs/updating-data-entities/index.html
deleted file mode 100644
index 580753f..0000000
--- a/website/publish/docs/updating-data-entities/index.html
+++ /dev/null
@@ -1,1270 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
- <meta charset="utf-8">
- <title>Apache Usergrid (incubating) — Updating 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>Updating 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/updating-data-entities.md">contribute to this article on github</a></small>
- -->
- </div>
- <div class="toc">
- <ul>
-<li>
-<a href="#updating-data-entities">Updating Data Entities</a><ul>
-<li>
-<a href="#updating-an-entity">Updating 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="#parameters-1">Parameters</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="#parameters-2">Parameters</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="#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="#example---response">Example - Response</a></li>
-<li><a href="#sdk-method-4">SDK Method</a></li>
-</ul>
-</li>
-<li>
-<a href="#updating-a-sub-property">Updating a sub-property</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-3">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="#parameters-4">Parameters</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="#parameters-5">Parameters</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="#example-requestresponse-10">Example Request/Response</a></li>
-<li><a href="#sdk-method-8">SDK Method</a></li>
-<li><a href="#example-requestresponse-11">Example Request/Response</a></li>
-<li><a href="#sdk-method-9">SDK Method</a></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-</div>
-<h1 id="updating-data-entities">Updating Data Entities</h1>
-<p>This article describes how to update entities in 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>
-<h2 id="updating-an-entity">Updating an entity</h2>
-<p>One or more properties can be updated with a single PUT request. For information on updating sub-properties, see <a href="#update_nested">Updating sub-properties</a> below.</p>
-<ul>
-<li><a href="#curl_update_entity">cURL</a></li>
-<li><a href="#ios_update_entity">iOS</a></li>
-<li><a href="#android_update_entity">Android</a></li>
-<li><a href="#javascript_update_entity">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_update_entity">Ruby</a></li>
-<li><a href="#nodejs_update_entity">Node.js</a></li>
-</ul>
-<h3 id="example-requestresponse">Example Request/Response</h3>
-<h4 id="request">Request:</h4>
-<pre><code>curl -X PUT https://api.usergrid.com/your-org/your-app/items/milk -d '{"price":"4.00", "availability":"in-stock"}'</code></pre>
-<h4 id="response">Response:</h4>
-<pre><code>{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "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" : 1378505705077,
- "availability" : "in-stock",
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "4.00"
- } ],
- "timestamp" : 1378505705050,
- "duration" : 87,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}</code></pre>
-<h3 id="request-syntax">Request Syntax</h3>
-<pre><code>curl -X PUT https://api.usergrid.com/<org>/<app>/<collection>/<entity> -d {<property>}</code></pre>
-<h3 id="parameters">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</p></td>
-<td align="left"><p>Organization UUID or organization name</p></td>
-</tr>
-<tr class="even">
-<td align="left"><p>app</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>entity</p></td>
-<td align="left"><p>Entity UUID or entity name</p></td>
-</tr>
-<tr class="odd">
-<td align="left"><p>property</p></td>
-<td align="left">
-<p>An entity property to be updated, formatted as a key-value pair. For example:</p>
-<pre><code>{"property_1":"value_1", "proper</code></pre>
-<p>ty_2“:”value_2“,…}</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-1">Example Request/Response</h3>
-<h4 id="request-1">Request:</h4>
-<pre><code>-(NSString*)updateEntity {
-
- //UUID of the entity to be updated
- NSString *entityID = @"f42752aa-08fe-11e3-8268-5bd5fa5f701f";
-
- //Create an entity object
- NSMutableDictionary *updatedEntity = [[NSMutableDictionary alloc] init ];
-
- //Set entity properties to be updated
- [updatedEntity setObject:@"item" forKey:@"type"]; //Required - entity type
- [updatedEntity setObject:@"in-stock" forKey:@"availability"];
- [updatedEntity setObject:@"4.00" forKey:@"price"];
-
- //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 updateEntity:entityID entity:updatedEntity];
-
- @try {
-
- //success
-
- }
- @catch (NSException * e) {
- //fail
- }
-
-}
- </code></pre>
-<h4 id="response-1">Response:</h4>
-<pre><code>{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "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" : 1378505705077,
- "availability" : "in-stock",
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "4.00"
- } ],
- "timestamp" : 1378505705050,
- "duration" : 87,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}</code></pre>
-<h3 id="sdk-method">SDK Method</h3>
-<pre><code>(ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity</code></pre>
-<h3 id="parameters-1">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">entityID</td>
-<td align="left">UUID of the entity to be updated</td>
-</tr>
-<tr class="even">
-<td align="left">updatedEntity</td>
-<td align="left">NSMutableDictionary containing the properties to be updated</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">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();
-
-//Create properties object
-
-String entityID = "fd0def5a-091c-11e3-a60d-eb644ab154cc";
-
-Map<String, Object> updatedProperties = new HashMap<String, Object>();
-updatedProperties.put("type", "item"); //Required
-updatedProperties.put("availability", "in-stock");
-updatedProperties.put("price", "4.00");
-
-//call updateEntityAsync to initiate the asynchronous API call
-dataClient.updateEntityAsync(entityID, updatedProperties, new ApiResponseCallback() {
-
- //If updateEntityAsync fails, catch the error
- @Override
- public void onException(Exception e) {
- // Error
- }
-
- //If updateEntityAsync 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":"put","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":"4.00","created":1378405020796,"name":"milk","modified":1378748497900,"availability":"in-stock","metadata":{"path":"/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"}}],"params":{},"path":"/items","rawResponse":"{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "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" : 1378748497900,
- "availability" : "in-stock",
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "4.00"
- } ],
- "timestamp" : 1378748497887,
- "duration" : 80,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}
-","uri":"http://api.usergrid.com/your-org/your-app/items","timestamp":1378748497887,"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":"5bb76bca-1657-11e3-903f-9ff6c621a7a4","price":"4.00","created":1378405020796,"name":"milk","modified":1378748497900,"availability":"in-stock","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":"5bb76bca-1657-11e3-903f-9ff6c621a7a4","price":"4.00","created":1378405020796,"name":"milk","modified":1378748497900,"availability":"in-stock","metadata":{"path":"/items/5bb76bca-1657-11e3-903f-9ff6c6
21a7a4"}},"organization":"your-org","duration":80,"applicationName":"your-app"}
- </code></pre>
-<h3 id="sdk-method-1">SDK Method</h3>
-<p>Asynchronous:</p>
-<pre><code>updateEntityAsync(String entityID, Map<String, Object> updatedProperties, ApiResponseCallback callback)</code></pre>
-<p>Synchronous:</p>
-<pre><code>updateEntity(String entityID, Map<String, Object> updatedProperties)</code></pre>
-<h3 id="parameters-2">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">entityID</td>
-<td align="left">UUID of the entity to be updated</td>
-</tr>
-<tr class="even">
-<td align="left">updatedProperties</td>
-<td align="left">Map object containing the properties to be updated. A ‘type’ property is required.</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) SDK</a>.</p>
-<h3 id="example-requestresponse-3">Example Request/Response</h3>
-<h4 id="request-3">Request:</h4>
-<pre><code>//Create the Apache Usergrid client object
-var dataClient = new Usergrid.Client({
- orgName:'your-org',
- appName:'your-app'
-});
-
-//Specify the UUID of the entity to be updated
-//and the properties to be updated
-var properties = {
- client:dataClient, //Required
- data:{'type':'item',
- uuid:'b3aad0a4-f322-11e2-a9c1-999e12039f87', //UUID of the entity to be updated is required
- price:'4.00',
- availability:'in-stock'
- }
-};
-
-//Create a new entity object that contains the updated properties
-var entity = new Usergrid.Entity(properties);
-
-//Call Entity.save() to initiate the API PUT request
-entity.save(function (error,response) {
-
- if (error) {
- //error
- } else {
- //success
- }
-
-});
- </code></pre>
-<h4 id="response-3">Response:</h4>
-<pre><code>Object {action: "put", application: "f34f4222-a166-11e2-a7f7-02e81adcf3d0", params: Object, path: "/items", uri: "http://api.usergrid.com/your-org/your-app/items"…}
-action: "put"
-application: "f34f4222-a166-11e2-a7f7-02e8sd83f3d0"
-applicationName: "your-app"
-duration: 62
-entities: Array[1]
-0: Object
-created: 1374534114329
-metadata: Object
-modified: 1376693371847
-name: "milk"
-price: "4.00" //updated
-availability: "in-stock" //updated
-varieties: Array[3] //This property was already present
-type: "item"
-uuid: "b3aad0a4-f322-11e2-a9c1-999e12039f87"
-varieties: Array[3]
-__proto__: Object
-length: 1
-__proto__: Array[0]
-organization: "your-org"
-params: Object
-path: "/items"
-timestamp: 1376693371836
-uri: "http://api.usergrid.com/your-org/your-app/items"
- </code></pre>
-<h3 id="sdk-method-2">SDK Method</h3>
-<pre><code>Entity.save();</code></pre>
-<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
-
- # Specify the name or uuid of the collection and entity to be updated
- # and the entity properties to be updated
- entity = client['item']['b3aad0a4-f322-11e2-a9c1-999e12039f87'].entity #entity object
- entity.price = '4.00'
- entity.availability = 'in-stock'
-
- # Call save to initiate the API PUT request
- entity.save
-
-rescue
-
- #fail
-
-end
- </code></pre>
-<h4 id="response-4">Response:</h4>
-<pre><code>{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "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" : 1378505705077,
- "availability" : "in-stock",
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "price" : "4.00"
- } ],
- "timestamp" : 1378505705050,
- "duration" : 87,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}</code></pre>
-<h3 id="sdk-method-3">SDK Method</h3>
-<pre><code>save</code></pre>
-<p>The example assumes use of 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>//Create the Apache Usergrid client object
-var dataClient = new Usergrid.client({
- orgName:'your-org',
- appName:'your-app'
-});
-
-//Specify the UUID of the entity to be updated
-//and the properties to be updated
-var properties = {
- client:dataClient, //Required
- data:{'type':'item',
- uuid:'b3aad0a4-f322-11e2-a9c1-999e12039f87', //UUID of the entity to be updated is required
- price:'4.00',
- availability:'in-stock'
- }
-};
-
-//Create a new entity object the contains the updated properties
-var entity = new Usergrid.entity(properties);
-
-//Call Entity.save() to initiate the API PUT request
-entity.save(function (error,response) {
-
- if (error) {
- //error
- } else {
- //success
- }
-
-});
- </code></pre>
-<h3 id="example---response">Example - Response</h3>
-<pre><code>{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "b3aad0a4-f322-11e2-a9c1-999e12039f87",
- "type" : "item",
- "name" : "milk",
- "created" : 1374534114329,
- "modified" : 1376695962803,
- "metadata" : {
- "path" : "/items/b3aad0a4-f322-11e2-a9c1-999e12039f87"
- },
- "name" : "milk",
- "price" : "4.00",
- "availability" : "in-stock"
- } ],
- "timestamp" : 1376695962790,
- "duration" : 144,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}
- </code></pre>
-<h3 id="sdk-method-4">SDK Method</h3>
-<pre><code>Entity.save();</code></pre>
-<h2 id="updating-a-sub-property">Updating a sub-property</h2>
-<p>Data entities may contain sets of sub-properties as nested JSON objects. Unlike normal entity properties, however, sub-properties cannot be updated individually. Updating a nested object will cause all sub-properties within it to be overwritten.</p>
-<p>For example, if you have a data entity with the following nested object:</p>
-<pre><code>"varieties": [
- {
- "name": "1%",
- "price": "3.25",
- "SKU": "0393847575533445"
- },
- {
- "name": "whole",
- "price": "3.85",
- "SKU": "0393394956788445"
- }
-]
- </code></pre>
-<p>and you send this update to Apache Usergrid:</p>
-<pre><code>"varieties": [
- {
- "name": "2%",
- "price": "3.00",
- },
- {
- "price": "4.00",
- }
-]
- </code></pre>
-<p>this will be the resulting nested object:</p>
-<pre><code>"varieties": [
- {
- "name": "2%",
- "price": "3.00",
- },
- {
- "price": "4.00",
- }
-]
- </code></pre>
-<ul>
-<li><a href="#curl_update_subproperty">cURL</a></li>
-<li><a href="#ios_update_subproperty">iOS</a></li>
-<li><a href="#android_update_subproperty">Android</a></li>
-<li><a href="#javascript_update_subproperty">JavaScript (HTML5)</a></li>
-<li><a href="#ruby_update_subproperty">Ruby</a></li>
-<li><a href="#nodejs_update_subproperty">Node.js</a></li>
-</ul>
-<h3 id="example-requestresponse-6">Example Request/Response</h3>
-<h4 id="request-6">Request:</h4>
-<pre><code>curl -X PUT https://api.usergrid.com/your-org/your-app/items/milk -d '{"varieties":[{"name":"1%","price":"3.25"},{"name":"whole","price":"4.00"}]}'</code></pre>
-<h4 id="response-5">Response:</h4>
-<pre><code>{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "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" : 1378761459069,
- "availability" : "in-stock",
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "uri" : "http://api.usergrid.com/your-org/your-app/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4",
- "varieties" : [ {
- "name" : "1%",
- "price" : "3.25"
- }, {
- "name" : "whole",
- "price" : "4.00"
- } ]
- } ],
- "timestamp" : 1378761459047,
- "duration" : 62,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}</code></pre>
-<h3 id="request-syntax-1">Request Syntax</h3>
-<pre><code>curl -X PUT https://api.usergrid.com/<org_id>/<app_id>/<collection>/<uuid|name> -d '{<property> : [{<sub_property>}, {<sub_property>}...]}'</code></pre>
-<h3 id="parameters-3">Parameters</h3>
-<table>
-<col width="16%">
-<col width="81%">
-<thead>
-<tr class="header">
-<th align="left">Parameter</th>
-<th align="left">Description</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td align="left">org_id</td>
-<td align="left">Organization UUID or organization name</td>
-</tr>
-<tr class="even">
-<td align="left">app_id</td>
-<td align="left">Application UUID or application name</td>
-</tr>
-<tr class="odd">
-<td align="left">collection</td>
-<td align="left">Name of the collection containing the entity to be updated</td>
-</tr>
-<tr class="even">
-<td align="left">uuid|name</td>
-<td align="left">UUID or name of the data entity to be updated</td>
-</tr>
-<tr class="odd">
-<td align="left">entity_property</td>
-<td align="left">The name of the entity property that contains the nested object to be updated</td>
-</tr>
-<tr class="even">
-<td align="left">sub_property</td>
-<td align="left">Entity properties of the nested object, as a set of key-value pairs in the format:<br><em>{<property_name> : <property_value>, <property_name> : <property_value> …}</em>
-</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*)updateEntity {
-
- //UUID of the entity to be updated
- NSString *entityID = @"f42752aa-08fe-11e3-8268-5bd5fa5f701f";
-
- //Define our two sub-properties to include in the update
- NSMutableDictionary *subproperty1 = [[NSMutableDictionary alloc] init];
- NSMutableDictionary *subproperty2 = [[NSMutableDictionary alloc] init];
- [subproperty1 setObject:@"1%" forKey:@"name"];
- [subproperty1 setObject:@"3.25" forKey:@"price"];
- [subproperty2 setObject:@"whole" forKey:@"name"];
- [subproperty2 setObject:@"4.00" forKey:@"price"];
-
- //Put our sub-properties into an NSArray
- NSArray *subproperties = [[NSArray alloc] initWithObjects:props1,props2, nil];
-
- //Create an NSMutableDictionary to hold our updates
- NSMutableDictionary *updatedEntity = [[NSMutableDictionary alloc] init ];
-
- //Set the properties to be updated
- [updatedEntity setObject:@"item" forKey:@"type"]; //Required - entity type
- [updatedEntity setObject:props forKey:@"varieties"];
-
- //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 updateEntity:entityID entity:updatedEntity];
-
- @try {
-
- //success
-
- }
- @catch (NSException * e) {
- //fail
- }
-
-}
- </code></pre>
-<h4 id="response-6">Response:</h4>
-<pre><code>{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "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" : 1378761459069,
- "availability" : "in-stock",
- "metadata" : {
- "path" : "/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- },
- "name" : "milk",
- "uri" : "http://api.usergrid.com/your-org/your-app/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4",
- "varieties" : [ {
- "name" : "1%",
- "price" : "3.25"
- }, {
- "name" : "whole",
- "price" : "4.00"
- } ]
- } ],
- "timestamp" : 1378761459047,
- "duration" : 62,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}</code></pre>
-<h3 id="sdk-method-5">SDK Method</h3>
-<pre><code>(ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity</code></pre>
-<h3 id="parameters-4">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">entityID</td>
-<td align="left">UUID of the entity to be updated</td>
-</tr>
-<tr class="even">
-<td align="left">updatedEntity</td>
-<td align="left">Entity object containing the properties to be updated</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();
-
-//UUID of the entity to be updated
-String entityID = "1ceed6ba-1b13-11e3-a7a6-59ffaee069e1";
-
-//The object we will pass to the API
-Map<String,Object> entityUpdates = new HashMap<String,Object>();
-
-//The objects we will need to setup the sub-properties
-ArrayList<Map<String,Object>> subPropertyArray = new ArrayList<Map<String,Object>>();
-Map<String,Object> subProperty1 = new HashMap<String,Object>();
-Map<String,Object> subProperty2 = new HashMap<String,Object>();
-
-//First sub-property
-subProperty1.put("name", "1%");
-subProperty2.put("price", "3.25");
-
-//Second sub-property
-subProperty2.put("name", "whole");
-subProperty2.put("price", "4.00");
-
-//Add the sub-properties to the List object
-subPropertyArray.add(subProperty1);
-subPropertyArray.add(subProperty2);
-
-//Now we put it all together
-entityUpdates.put("type", "item"); //Required
-entityUpdates.put("varieties", subPropertyArray);
-
-
-//call updateEntityAsync to initiate the asynchronous API call
-dataClient.updateEntityAsync(entityID, updatedProperties, new ApiResponseCallback() {
-
- //If updateEntityAsync fails, catch the error
- @Override
- public void onException(Exception e) {
- // Error
- }
-
- //If updateEntityAsync 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-7">Response:</h4>
-<pre><code>{"action":"put","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":"1ceed6ba-1b13-11e3-a7a6-59ffaee069e1","varieties":[{"name":"1%","price":"3.25"},{"name":"whole","price":"4.00"}],"created":1378925465499,"name":"milk","modified":1378936578609,"metadata":{"path":"/items/1ceed6ba-1b13-11e3-a7a6-59ffaee069e1"}}],"params":{},"path":"/items","rawResponse":"{
- "action" : "put",
- "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0",
- "params" : { },
- "path" : "/items",
- "uri" : "http://api.usergrid.com/your-org/your-app/items",
- "entities" : [ {
- "uuid" : "1ceed6ba-1b13-11e3-a7a6-59ffaee069e1",
- "type" : "item",
- "name" : "milk",
- "created" : 1378925465499,
- "modified" : 1378936578609,
- "metadata" : {
- "path" : "/items/1ceed6ba-1b13-11e3-a7a6-59ffaee069e1"
- },
- "name" : "milk",
- "varieties" : [ {
- "name" : "1%",
- "price" : "3.25"
- }, {
- "name" : "whole",
- "price" : "4.00"
- } ]
- } ],
- "timestamp" : 1378936578595,
- "duration" : 75,
- "organization" : "your-org",
- "applicationName" : "your-app"
-}
-","uri":"http://api.usergrid.com/your-org/your-app/items","timestamp":1378936578595,"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":"1ceed6ba-1b13-11e3-a7a6-59ffaee069e1","varieties":[{"name":"1%","price":"3.25"},{"name":"whole","price":"4.00"}],"created":1378925465499,"name":"milk","modified":1378936578609,"metadata":{"path":"/items/1ceed6ba-1b13-11e3-a7a6-59ffaee069e1"}},"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":"1ceed6ba-1b13-11e3-a7a6-59ffaee069e1","varieties":[{"name":"1%","price":"3.25"},{"name":"whole","price":"4.00"}],"created":1378925465499,"name":"milk","modified":137
8936578609,"metadata":{"path":"/items/1ceed6ba-1b13-11e3-a7a6-59ffaee069e1"}},"organization":"your-org","duration":75,"applicationName":"your-app"}
- </code></pre>
-<h3 id="sdk-method-6">SDK Method</h3>
-<p>Asynchronous:</p>
-<pre><code>updateEntityAsync(String entityID, Map<String, Object> updatedProperties, ApiResponseCallback callback)</code></pre>
-<p>Synchronous:</p>
-<pre><code>updateEntity(String entityID, Map<String, Object> updatedProperties)</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">entityID</td>
-<td align="left">UUID of the entity to be updated</td>
-</tr>
-<tr class="even">
-<td align="left">updatedProperties</td>
-<td align="left">Map object containing the properties to be updated. A ‘type’ property is required.</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) SDK</a>.</p>
-<h3 id="example-requestresponse-9">Example Request/Response</h3>
-<h4 id="request-9">Request:</h4>
-<pre><code>//Create the Apache Usergrid client object
-var dataClient = new Usergrid.Client({
- orgName:'your-org',
- appName:'your-app'
-});
-
-//Specify the UUID of the entity to be updated
-//and the properties to be updated
-var properties = {
- client:dataClient, //Required
- data:{
- type:'item',
- uuid:'b151ddba-0921-11e3-9f60-2ba945ba461f',
- varieties:[
- {"name":"3%", "price":"3.25", "SKU":"9384752200033"},
- {"name":"whole", "price":"4.00", "SKU":"9384752200033"}
- ]
- }
-};
-
-//Create a new entity object that contains the updated properties
-var entity = new Usergrid.Entity(properties);
-
-//Call Entity.save() to initiate the API PUT request
-entity.save(function (error,response) {
-
- if (error) {
- //error
- } else {
- //success
- }
-
-});
- </code></pre>
-<h4 id="response-8">Response:</h4>
-<pre><code>Object {action: "put", application: "f34f4222-a166-11e2-a7f7-02e81adcf3d0", params: Object, path: "/items", uri: "http://api.usergrid.com/your-org/your-app/items"…}
-action: "put"
-application: "f34f4222-a166-11e2-a7f7-02e81adcf3d0"
-applicationName: "your-app"
-duration: 66
-entities: Array[1]
- 0: Object
- availability: "in-stock"
- created: 1378405020796
- metadata: Object
- modified: 1378760239203
- name: "milk"
- price: "4.00"
- type: "item"
- uri: "http://api.usergrid.com/your-org/your-app/items/5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- uuid: "5bb76bca-1657-11e3-903f-9ff6c621a7a4"
- varieties: Array[2]
- 0: Object
- SKU: "9384752200033"
- name: "3%"
- price: "3.25"
- __proto__: Object
- 1: Object
- SKU: "9384752200033"
- name: "whole"
- price: "4.00"
- __proto__: Object
- length: 2
- __proto__: Array[0]
- __proto__: Object
- length: 1
-__proto__: Array[0]
-organization: "your-org"
-params: Object
-path: "/items"
-timestamp: 1378760239191
-uri: "http://api.usergrid.com/your-org/your-app/items"
-__proto__: Object
- </code></pre>
-<h3 id="sdk-method-7">SDK Method</h3>
-<pre><code>Entity.save();</code></pre>
-<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>
-<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 and entity to be updated
- # and the entity properties to be updated
- entity = client['item']['b3aad0a4-f322-11e2-a9c1-999e12039f87'].entity #entity object
- entity.varieties = [
- {
- "name" => "1%",
- "price" => "3.25",
- "sku" => "0393847575533445"
- },{
- "name" => "whole",
- "price" => "3.85",
- "sku" => "0393394956788445"
- }
- ]
-
- # Call save to initiate the API PUT request
- entity.save
-
-rescue
-
- #fail
-
-end
- </code></pre>
-<h4 id="response-9">Response:</h4>
-<p>[[nid:11954]</p>
-<h3 id="sdk-method-8">SDK Method</h3>
-<pre><code>save</code></pre>
-<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>//Create the Apache Usergrid client object
-var dataClient = new Usergrid.client({
- orgName:'your-org',
- appName:'your-app'
-});
-
-//Specify the UUID of the entity to be updated
-//and the properties to be updated
-
-var properties = {
- client:dataClient, //Required
- data:{
- type:'item',
- uuid:'b3aad0a4-f322-11e2-a9c1-999e12039f87', //UUID of the entity to be updated is required
- varieties : [
- {
- "name" : "1%",
- "price" : "3.25",
- "sku" : "0393847575533445"
- },{
- "name" : "whole",
- "price" : "3.85",
- "sku" : "0393394956788445"
- },{
- "name" : "skim",
- "price" : "4.00",
- "sku" : "0390299933488445"
- }
- ]
- }
-};
-
-//Create a new entity object the contains the updated properties
-var entity = new Usergrid.entity(properties);
-
-//Call Entity.save() to initiate the API PUT request
-entity.save(function (error,response) {
-
- if (error) {
- //error
- } else {
- //success
- }
-
-});
- </code></pre>
-<h4 id="response-10">Response:</h4>
-<pre><code>{ action: 'put',
- application: 'f34f4222-a166-11e2-a7f7-02e81adcf3d0',
- params: {},
- path: '/items',
- uri: 'http://api.usergrid.com/your-org/your-app/items',
- entities:
- [ { uuid: 'b3aad0a4-f322-11e2-a9c1-999e12039f87',
- type: 'item',
- created: 1374534114329,
- modified: 1377039726738,
- metadata: [Object],
- varieties: [Object] } ],
- timestamp: 1377039726724,
- duration: 75,
- organization: 'your-org',
- applicationName: 'your-app' }
- </code></pre>
-<h3 id="sdk-method-9">SDK Method</h3>
-<pre><code>Entity.save();</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="/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/updating-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>