Get Cms content

get https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/cms/{entityLookupId}

Returns an Entity's CMS content as a streamlined value-based object.

It's possible to specify a depth which allows the method traverse through any references
to other Entities, returning a full structure.

It is also possible to specify a Member, allowing any scripting to access Member information for deep personalisation.

Path Params

space

string

required

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

entityLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

Query Params

member

string

Optional Member Lookup Id. This allows any scripts within the CMS content to access the Member's model and provide personalised content.

depth

int32

If this Document references other documents, then the CMS for that document can be returned too. This attribute controls how many levels down should be iterated.
Default is 1, meaning only this document's CMS data is returned.

dim

string

The Dimensions under which the calling application operates.
Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

bypassDimensionGate

boolean

If true, returns resources even if the Entity's Dimension filter doesn't match the passed in Dimensions.
Default is false.

includeUnpublished

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

Response

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://neon-loyalty-qa.spika.com/loyalty/v1/space/cms/entityLookupId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK