Skip to main content

API Reference

Overview

The XINA API (or XAPI) provides programmatic access to a XINA server. Note that client applicati...

JSON Implementation

XINA API actions and responses are encoded in JSON, a common, widely supported, human-readable fo...

Binary Objects

Binary objects are used to import any type of binary data. This may be used in conjuction with th...

Data Actions

Data actions read from or write to XINA databases. Read Actions SELECT The primary read action in...

Admin Actions

Administrative actions create, modify, or delete XINA data structures, perform user management, o...

Task Actions

Task actions provide features for running and interacting with asynchronous tasks managed by the ...

Struct Actions

Struct actions are complex data actions designed to be used with XINA Structs. Unlike most API ac...

System Actions

System actions are used for internal functions, client-specific features, and debugging. ACCESS R...

Specifier Syntax

Specifiers are objects which specify schema or data elements. In general a specifier is an object...

Record Syntax

JSON Format A single record may be encoded as a JSON object: Property Value <field name / ...

Expression Syntax

XINA expressions translate to MySQL expressions, which are evaluated as a query is executed. All ...

Select Syntax

The SELECT syntax is essentially a JSON representation of the MySQL SELECT syntax. See the MySQL ...

Definitions Syntax

Under Construction Group Defines a XINA group. Property Value name string desc string ...

Action Index

ACCESS Acquire temporary access ID for websocket connection. ALTER Edit schema or user properties...