Query Collection

This endpoint can be used to extract one or more documents from a Xenioo Database Collection.

Requirements

To successfully invoke this endpoint :

  1. A Bot Level Authorization Token must be created and sent in the header.

  2. An active Database package must be active on the target account.

  3. The desired collection must exist and must be flagged as accessible through API.

Request

The following request shows how to extract a single document from a Xenioo Database Collection:

curl --location --request GET 'https://<NODE>.xenioo.com/data/<COLLECTIONNAME>/<DOCUMENT ID>' \
--header 'Authorization: Bearer <BOT AUTH TOKEN>'

URL Filtering Syntax can be used on the request in place of <DOCUMENT ID> to extract multiple documents with a single call.

Multiple records can be retrieved without a filter specified by supplying a * (asterisk) in place of a <DOCUMENT ID> or URL Filtering query. Extraction of all documents with no filter specified is limited to 1024 documents.

Response

If successful, this call will return the raw JSON of all the extracted records.

Response Codes

This endpoint will reply with the following standard HTTP codes.

Code

Meaning

200

Ok. The request has been successfully fulfilled.

400

Bad Request. The call does not contain the data required to be fulfilled.

404

Not Found. The specified collection has not been found.

403

Unauthorized. The specified collection cannot be access through API