Save To Collection

This endpoint can be used to insert or update a document inside a Xenioo Database Collection. Documents inside a collection are specified as pure JSON payloads.

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 insert a new document inside a Xenioo Database Collection:

curl --location --request POST 'https://<NODE>.xenioo.com/data/<COLLECTIONNAME>' \
--header 'Authorization: Bearer <BOT AUTH TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
	  "Color":"Red",
    "Value":123
}'

As long as the supplied JSON payload is valid, it will be inserted in the target collection, regardless of the structure of other existing documents.

If supplied, the _id field will be used to update a specific document. If the document does not exist a new document will be created and assigned the supplied id.

Response

If successful, the unique id of the affected document will be returned.

{
    "id":"<some unique id>"
}

Response Codes

This endpoint will reply with the following standard HTTP codes.

PreviousUrl Filtering SyntaxNextDelete From Collection

Last updated