UpdateSystemEntity

Updates a System Entity, regardless of the ACL permissions of the object. This method is very useful when dealing with read-only system entities - since otherwise because they do not have an owner, they would not be editable at all. Note that for obvious security reasons, this API method is available via cloud-code only.

This method is affected by versioning. See the versioning documentation for more information.

Service	Operation
globalEntity	UPDATE

Method Parameters

Parameter	Description
entityId	The id of the entity to update
version	The version of the entity to update. Use -1 to indicate the newest version
jsonEntityData	The entity's data object

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

Obj-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

Roblox

// N/A

GDScript

N/A

Cloud Code

var entityId = "a-entity-id";
var version = 1;
var jsonEntityData = {
    "street": "1309 Carling"
};
var globalEntityProxy = bridge.getGlobalEntityServiceProxy();

var postResult = globalEntityProxy.updateSystemEntity(entityId, version, jsonEntityData);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "globalEntity",
    "operation": "UPDATE",
    "data": {
        "entityId": "the-entity-id",
        "version": 1,
        "data": {
            "street": "1309 Carling"
        }
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "gameId": "123456",
        "entityId": "14281c38-abf6-4ca2-8436-b2bdwas8d5a9a",
        "ownerId": "784cc6c6-4569-4d75-bd10-62dwa8ae0218",
        "entityType": "test",
        "entityIndexedId": "indexTest",
        "version": 1,
        "acl": {
            "other": 1
        },
        "expiresAt": 1449861422588,
        "timeToLive": 34567,
        "createdAt": 1449861388021,
        "updatedAt": 1449861388021
    }
}

Common Error Code

Status Codes

Code	Name	Description
40344	ENTITY_VERSION_MISMATCH	The version passed in does not match the version of the entity on the server