Version: 4.15.0

Global Entity

Overview

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.