Custom Entity

Custom Entities are very similar to Global Entities, but with several advanced features that make them more applicable for larger data sets.

tip

Custom Entities are a premium feature available to Plus Plan customers. Additional usage fees apply.

API Summary

Bypassing ACL for System Objects

• SysCreateEntity - Creates new custom entity.
• SysDeleteEntity - Deletes the specified custom entity on the server.
• SysDeleteEntities - Deletes all applicable custom entities from the server based on the custom entity type, specified delete criteria and acrossAllUsers flag.
• SysGetCount - Counts the number of custom entities meeting the specified where clause.
• SysGetEntityPage - Retrieves first page of custom entities from the server based on the custom entity type and specified query context
• SysGetEntityPageOffset - Gets the page of custom entities from the server based on the encoded context and specified page offset.
• SysGetRandomEntitiesMatching - Gets a list of up to maxReturn randomly selected custom entities from the server based on the entity type and where condition, bypassing ownership/ACL permissions checking.
• SysIncrementData - Increments the specified fields by the specified amount within custom entity data on the server.
• SysIncrementData - Increments the specified fields by the specified amount within custom entity data on the server, bypassing ownership/ACL permissions checks.
• SysIncrementDataSharded - Increments the specified fields by the specified amount within custom entity data on the server, bypassing ownership/ACL permissions.
• SysReadEntity - Reads a custom entity.
• SysUpdateEntity - Replaces the specified custom entity's data, and optionally updates the acl and expiry, on the server.
• SysUpdateEntityFields - Sets the specified fields within custom entity data on the server.
• SysUpdateEntityFieldsSharded - For sharded custom collection entities. Sets the specified fields within custom entity data on the server, bypassing ACL permissions checks.
• SysUpdateEntityOwner - Updates the owner of the custom entity.

Schema Management

• SysCreateCollection - Creates configuration for new custom entity collection.
• SysCreateIndex - Creates a new index on a custom entity collection.
• SysDropCollection - Drops the specified custom entity collection.
• SysDropIndex - Drops the specified index from the identified custom entity collection.
• SysListCollections - Lists the custom entity collections configured for the application.
• SysListIndexes - Retrieves list of indexes configured for a custom entity collection.
• SysUpdateCollectionMigrate - Updates the migration flag for the custom entity collection.

tip

All the client APIs that the names beigin with "Sys" are also available to S2S. For the usages of the S2S customEntity APIs (if they are not listed at this section), refer to brainCloud client customEntity APIs.

📄️ SysCreateCollection

Creates configuration for new custom entity collection.

📄️ SysCreateIndex

Creates a new index on a custom entity collection.

📄️ SysDeleteEntities

Deletes all applicable custom entities from the server based on the custom entity type, specified delete criteria and acrossAllUsers flag, bypassing ownership/ACL checks.

📄️ SysDropIndex

Drops the specified index from the identified custom entity collection.

📄️ SysListCollections

Lists the custom entity collections configured for the application.

📄️ SysListIndexes

Retrieves list of indexes configured for a custom entity collection.