GetSystemEntityList

Method gets list of system entities from the server base on type and/or where clause.

Fields available for use in the 'where' clause are:

• entityType

• entityIndexedId

• createdAt

• updatedAt

• ownerId

• timeToLive

  Along with all custom data (using data.). For more information on the query syntax see here.

Service	Operation
globalEntity	GET_SYSTEM_ENTITY_LIST

Method Parameters

Parameter	Description
where	Mongo style query string
orderBy	Specifies the order in which the query returns matching documents. The sort parameter consists of a field followed by an ascending(1)/descending flag(-1). eg. { "name" : 1} sorts by name in ascending order
maxReturn	The maximum number of entities to return

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 where = {
    "entityType": "address"
};
var orderBy = {
    "data.address": 1
};
var maxReturn = 50;
var globalEntityProxy = bridge.getGlobalEntityServiceProxy();

var postResult = globalEntityProxy.getSystemEntityList(where, orderBy, maxReturn);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "globalEntity",
    "operation": "GET_SYSTEM_ENTITY_LIST",
    "data": {
        "where": {
            "entityType": "address"
        },
        "orderBy": {
            "data.address": 1
        },
        "maxReturn": 50
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "entityList": [
            {
                "gameId": "123456",
                "entityId": "e919ffc2-c3f7-4cc0-a0f1-b3eb857c4ed0",
                "ownerId": "7f416676-9e9d-422f-85b2-740185ac3139",
                "entityType": "testGlobalEntity",
                "entityIndexedId": null,
                "version": 1,
                "data": {
                    "globalTestName": "Test Name 01"
                },
                "acl": {
                    "other": 0
                },
                "expiresAt": 9223372036854775800,
                "timeToLive": 0,
                "createdAt": 1471010732135,
                "updatedAt": 1471010732135
            }
        ],
        "_serverTime": 1637946319239,
        "entityListCount": 1
    }
}