Query Entities

get https://neon-config-qa.spika.com/config/v1/{space}/entities

This generic method is used for querying or exporting Entity configurations
regardless of the type of Entity.

Refer to the specific API endpoint documentation for each type of Entity for details on the config attributes and
other specific details.

Path Params

space

string

required

The name of the space (database) assigned to you.

Query Params

type

array of strings

Limits the result by one or more (comma-separated) types.

type

subType

array of strings

Limits the result by one or more (comma-separated) sub-types. Only allowed together with the type parameter.

subType

category

string

Limits the result by category. The * wildcard is supported.

state

array of strings

Limits result to one or more (comma-separated) specific states

state

string

Limits the result by looking for the search string within the Entity's id, business id, name and description.
The * wildcard is supported, but is automatically added to the beginning and end. The search string is NOT case sensitive.

assignedTo

string

Limits the result to Entities assigned to a specific user. The * wildcard is supported. Not case sensitive.

dim

string

Limits the result analysing the Entities' Dimension Gate to ensure that is matches the passed in Dimensions.

The format for this parameter is <dimension>:<value>;<dimension>:<value>;... etc, for example country:US;language:en;channel:email

page

int32

Defaults to 0

Used together with pageSize. First page is zero, which is also the default.

pageSize

int32

Defaults to 100

Specifies the number of content items to return per page. Default is 100.

sort

string

Defaults to entityId

Overrides the default sorting. Useful together with pagination.
One or more sort attributes can be specified, and it's possible to control ascending or descending order,
for example 'category,-created' sorts first by category in ascending order and then created in descending order.

The supported fields are id, bizId, name, category, type, subType, state, assignedTo, created and , updated.

includeSystemEntities

boolean

Defaults to true

Boolean flag to include or exclude system entities from the results.

hideFields

array of strings

Optional comma-separated list of fields to hide from the returned result,
Most fields in the root object can be specified, for example: hideFields=assignedTo,category,runInfo,cms,metaData.

This is useful for reducing the size of the Json result, but can also have a big impact on performance.
It is recommended to hide especially runStatus unless it's needed.

hideFields

hideEntityInfo

boolean

If true, excludes the *Info fields from the returned result, including within the configuration.
Setting this to true helps improve performance.

convertGeneratedIds

boolean

If true, converts any generated Entity Id fields in the configuration to instead return the referenced Entity's name.
This is very hepful when comparing configurations between different environments, as the generated Entity Ids would otherwise be different and not comparable.

Note that returning the names instead of the Ids still generates valid Json configurations, since all Entity Id fields accept lookupIds when saving

countTotals

boolean

Defaults to true

Setting this to false means that the total number of pages and entities won't be returned. This helps improve performance, so set this to false unless pagination is needed.

Response

Response body

object

content

array of objects

content

object

assignedTo

string

length between 0 and 50

Can contain the user Id of a portal user who the Entity belongs to.

bizId

string

length between 0 and 50

An optional business identifier for the Entity.
This may be a reference to a different system, and if specified must be unique across the platform.
When looking up Entities by business Id, it must be preceded by the '$' sign.

category

string

length between 0 and 50

An optional free-text field which can be used by applications to categorize Entities or filter by and group related Entities.

cmsContent

object

Optional rich content associated with the Entity. Not applicable for all Entity Types.

cmsDefinitionId

string

Optional CMS Definition assigned to the Entity to control and validate associated CMS fields. Not applicable to all Entity Types.

cmsDefinitionInfo

object

Additional information about the Cms Definition Id.

config

object

Configuration JSON, specific to each type of Entry

Has additional fields

description

string

length between 0 and 1000

An optional description of what the Entity is for.

dimensionGate

json

Optional Dimension Gate, controlling under what circumstances the Entity is accessible. Not applicable for all Entity Types.

string

length ≤ 15

Unique Internal Id of the entity. Set on creation and can't be changed.
Lowercase letters, digits and underscore allowed.
If not specified then an id will be generated.

metadata

object

Populated by the platform. Can't be set or modified.

name

string

required

length between 0 and 100

The unique name of the entity (case sensitive).
Upper and lowercase, digits and undescore allowed.
When referencing Entities by name in scripts, the name should be preceded by the '@' sign.

runStatus

object

Current information and status linked to an installed entity. Read only. Not aplicable for all Entity Types.

Has additional fields

state

string

required

The Entity's state

DRAFT INSTALLED PUBLISHED ARCHIVED DELETED INVALID

system

boolean

True if the Entity is part of the NEON System configuration and therefore shouldn't be modified or uninstalled.

type

string

The type of the Entity. Read only.

CMS_DEFINITION CMS_DOCUMENT CODE_BANK CODE_SET COMPETITION CUSTOM DIMENSION FORM FUNNEL GAME JOB JOURNEY LIST MEMBER MESSAGE_SERVER MESSAGE_TEMPLATE OFFER ORDER_SET RELATIONSHIP SHEET SURVEY USER_ROLE VOTE WALLET

elements

int32

page

int32

pageSize

int32

totalElements

int64

totalPages

int32

xxxxxxxxxx
curl --request GET \
     --url 'https://neon-config-qa.spika.com/config/v1/space/entities?page=0&pageSize=100&sort=entityId&includeSystemEntities=true&countTotals=true' \
     --header 'accept: application/json'

200OK