API Endpoints

RestAPI publisher transport provides a number of endpoints to access data ingested and processed within the Joule process. Raw and processed events are stored within the internal SQL database which are then made accessible to users via rest endpoints.

Swagger Support

All endpoints have OpenAPI support via swagger docs url

http://<host>:7070/swagger

Driver details

io.javalin:javalin:5.6.3

Supported endpoints

Oveview of supported rest endpoints. All data is returned as Json StreamEvents with the exception of export endpoint which is user definable.

// List available schema and table queries
http://<host>:7070/joule/query/list

// Query schema table
http://<host>:7070/joule/query/{schema}/{table}

// Export schema table as a typed file
http://<host>:7070/joule/export/{schema}/{table}/{type}

// Delete schema table
http://<host>:7070/joule/delete/{schema}/{table}

List available queries

Get a list of available query tables.

Endpoint

// Some code
http://localhost:7070/joule/query/list

Query table

Query an internal SQL table with or without a date time range based of ingestTime constraint. The returned query resultset is constrainted to a specified page size.

Endpoint

http://localhost:7070/joule/query/{schema}/{table}

Parameters

Attribute	Description	Type	Required
schema	Database schema is use	Path
table	Table to export from	Path
from	DateTime format e.g. YYYY-MM-dd hh:mm:ss	Query
to	DateTime e.g. YYYY-MM-dd hh:mm:ss	Query
offset	Event page offset	Integer
pageSize	Number of events to return per page Default: 1000	Integer

Export data

Export event data to a typed file using a date time range constraint, uses ingestTime field to restrict the query result. Parquet and CSV files are generated based upon user request parameter.

Endpoint

http://localhost:7070/joule/export/{schema}/{table}

Parameters

Attribute	Description	Type	Required
schema	Database schema is use	Path
table	Table to export from	Path
type	Options: parquet, csv	Query
from	DateTime format e.g. YYYY-MM-dd hh:mm:ss	Query
to	DateTime e.g. YYYY-MM-dd hh:mm:ss	Query
path	Destination directory and file name e.g. /tmp/events.parquet	Query

Delete data

Delete event data from an internal database table using a date time crirtera. The query uses ingestTime field to restrict the data deleted.

Endpoint

http://localhost:7070/joule/delete/{schema}/{table}/{type}

Parameters

Attribute	Description	Type	Required
schema	Database schema is use	Path
table	Table to export from	Path
from	DateTime format e.g. YYYY-MM-dd hh:mm:ss	Query
to	DateTime e.g. YYYY-MM-dd hh:mm:ss	Query

Default configuration

http://<host>:7070/joule/