Skip to main content

Query and response

A client sends an ordered JSON array of commands and, when needed, an array of binary inputs. ApertureDB returns a JSON response and a separate array of binary outputs. Client libraries handle the transport.

What the exchange between client and server looks like.​

The API description defines complete requests and blob ordering. Responses defines successful results, transaction errors, and failures during response construction. Some failures produce a single error object rather than one result per command.

Query and Response​

A query can filter objects, pass selections between commands using references, and specify which properties, aggregates, or binary data to return.

Command​

Each command adds, finds, updates, or deletes an object, or performs an administrative operation. The command reference defines its parameters and prerequisites.

Blob​

A blob is a binary buffer, such as the bytes of an image or a descriptor. The media input and output guide describes how applications prepare and consume these buffers.

Result​

The results parameter selects properties or aggregates to return. The blobs parameter requests binary data from commands that support it. A reference-only lookup can return no properties while still selecting objects for later commands.