API Reference
Start typing to search…

Query Custom Resources

get https://neon-loyalty-qa.spika.com/loyalty/v1//custom
Path Params
string
required

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

Query Params
string

Query field used to limit the result by filtering on one or more resource attributes. See documentation on filter expressions.

The format is {field1}:{filter1} [;{field2}:{filter2} [;...]]. Example 'qry=name:A..Z;category:B;state:INSTALLED'.

Alternatively, the fields can be passed as separate query parameters prefixed with 'qry_', for example:
'qry_name=A..Z&qry_category=B&qry_state=INSTALLED'.

The following resource fields can be queried: category, name, biz_id, sub_type, state

int32
Defaults to 0

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

int32
Defaults to 100

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

string
Defaults to created

Optional sorting, using the format: {[-]{field1} [,[-]{field2} [,...]]. See documentation on sorting.

Available fields for sorting are: id, bizId, name, state, subType, category, created

string

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

boolean

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

boolean

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

Response

Updated 5 months ago

Did this page help you?
Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?