Skip to content

Key format

shz edited this page Aug 5, 2011 · 1 revision

Key Format

A key is simply a string that identifies one or more objects. At the moment, there are two ways of doing this.

Single Objects

This is the most straightforward approach, as the key is simply the object's ID, which itself is of the format

[type]/[hex]

Example:

convo/1234dead5678beef

Related Query

This will return multiple objects, is formatted as such:

[type]([field]=[id])

Where type is the type of the object to return, field is the "foreign key" field, and id is the related object.

Example:

convo(listing=listing/2)

This would return all conversations where the related listing field is "listing/2".

Clone this wiki locally