SysUpdateEntityFieldsSharded

For sharded custom collection entities. Sets the specified fields within custom entity data on the server, bypassing ACL permissions checks.

Service	Operation
customEntity	SYS_UPDATE_ENTITY_FIELDS_SHARDED

Method Parameters

Parameter	Description
entityType	The type of custom entity being updated.
entityId	The id of custom entity being updated.
version	Version of the custom entity being updated.
fieldsJson	Specific fields, as JSON, to set within entity's custom data.
shardKeyJson	The shard key field(s) and value(s), as JSON, applicable to the entity being updated.

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Objective-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var entityType = "athletes";
var entityId = "aaaa-bbbb-cccc-dddd";
var version = 1;
var fieldsJson = {
  "stats.gamesPlayedTotal": 2,
  "stats.goalsTotal": 2,
  "games.played": [
    {
      "date": "2022-01-21",
      "goals": 1,
      "assists": 1,
      "penalties": 0
    },
    {
      "date": "2022-01-10",
      "goals": 1,
      "assists": 0,
      "penalties": 1
    }
  ]
};
var shardKeyJson = {
  "ownerId": "profileIdOfEntityOwner"
};
var customEntityProxy = bridge.getCustomEntityServiceProxy();

var postResult = customEntityProxy.sysUpdateEntityFieldsSharded(entityType, entityId, version, fieldsJson, shardKeyJson);
if (postResult.status == 200) {
  // Success!
}

Raw

// Cloud Code only. To view example, switch to the Cloud Code tab

JSON Response

{
  "data": {
    "timeToLive": null,
    "createdAt": 1643144091464,
    "entityType": "athletes",
    "entityId": "bc7ea530-c6bd-4a27-bb5d-ced287991c87",
    "acl": {
      "other": 2
    },
    "ownerId": "b85f195e-b65f-4220-b84f-260e42b01c5b",
    "version": 3,
    "expiresAt": null,
    "updatedAt": 1643213631138
  },
  "status": 200
}