Global Entity

A summary on GlobalEntityService can be found in the client API section of the documentation.

Changes made to SystemEntities (GlobalEntities that have no ownerId) can only be ran via the cloudCode S2S script. Removing write access to the client ensures the data is protected from user alteration, while still allowing for cloud code scripts to run and edit the entity data.

Existing GlobalEntities can be converted to SystemEntities using MakeSystemEntity.

API Summary

GlobalEntity

• CreateSystemEntity - Create a new entity on the server.
• CreateSystemEntityWithIndexedId - Create a new system entity on the server with an indexed id.
• UpdateSystemEntity - Updates an existing system entity on the server.
• UpdateSystemEntityAcl - Updates an existing system entity's Acl on the server.
• UpdateEntityIndexedId - Updates an existing entity's IndexedId on the server.
• DeleteSystemEntity - Deletes an existing system entity on the server.
• ReadEntity - Reads an existing entity from the server.
• ReadSystemEntity - Reads an existing system entity from the server.
• GetList - Get a list of entities from the server base on where. Where clause allows entityType, createdAt, updatedAt, data items.
• GetListByIndexedId - Get a list of entities from the server base on indexed id.
• GetSystemEntityList - Get a list of system entities from the server base on where. Where clause allows entityType, createdAt, updatedAt, data items.
• GetListCount - Get a count of entities from the server base on where. Where clause allows entityType, createdAt, updatedAt, data items.
• GetSystemEntityListCount - Get a count of system entities from the server base on where. Where clause allows entityType, createdAt, updatedAt, data items.
• GetPage - Gets the page of entities from the server based on the specified context.
• GetSystemEntityPage - Gets the page of system entities from the server based on the specified context.
• GetPageOffset - Gets the page of entities from the server based on the encoded context and specified page offset.
• GetSystemEntityPageOffset - Gets the page of entities from the server based on the encoded context and specified page offset.

For more information on how brainCloud organizes data, refer to the Cloud Data Overview.

📄️ CreateSystemEntity

Method creates a new system new entity on the server.

📄️ CreateSystemEntityWithIndexedId

Create a new system entity on the server with an indexed id.

📄️ DeleteSystemEntity

Method deletes an exisiting system entity on the server.

📄️ GetList

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

📄️ GetListByIndexedId

Get a list of entities from the server base on indexed id.

📄️ GetListCount

Method gets a count of entities based on the where clause.

📄️ GetPage

Method uses a paging system to iterate through user entities.

📄️ GetPageOffset

Method to retrieve previous or next pages after having called the GetPage method.

📄️ GetSystemEntityList

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

📄️ GetSystemEntityListCount

Method gets a count of system entities based on the where clause.

📄️ GetSystemEntityPage

Method uses a paging system to iterate through global system entities.

📄️ GetSystemEntityPageOffset

Method to retrieve previous or next pages after having called the GetSystemEntityPage method.

📄️ ReadEntity

Method reads an existing entity on the server. It must have public read access.

📄️ ReadSystemEntity

Method reads an existing system entity on the server. It cannot be an owned/global entity.

📄️ UpdateEntityIndexedId

Updates an existing entity's IndexedId on the server.

📄️ UpdateSystemEntity

Method updates the data of an exisiting system entity on the server.

📄️ UpdateSystemEntityAcl

Method updates the acl of an exisiting system entity on the server.