home api list

Hexostore API Documentation

annotation

/api/annotation/

List methods: get, post, patch

Detail methods: get, put, patch, delete

Manual annotation:

Fields

annotation:

Unicode string data. Ex: "Hello World"

This field will default to: '' (empty string)

datatype:

A reference to the resource. Maybe specified by URI or ID. Using a URI is recommended.

This field may be blank

id:

The primary key for this resource. Integer data. Ex: 2673

This field may be blank

This field will default to: '' (empty string)

last_modified:

A date & time as a string. Ex: "2010-11-10T03:07:43"

This field may be blank

This field will default to: True

record:

A reference to the resource. Maybe specified by URI or ID. Using a URI is recommended.

This field may be blank

This field may be null

resource_uri:

The unique URI where the object resides.

This field is readonly.

start:

Start timestamp.

This field is required.

start_date:

A date & time as a string. Ex: "2010-11-10T03:07:43"

This field is readonly.

user:

A user. Maybe specified by URI, email, or ID. Using a URI is recommended.

This field is required.

Filtering Options

datatype: exact, in, gt, gte, lt, lte, range

id: exact, in, gt, gte, lt, lte, range

last_modified: exact, in, gt, gte, lt, lte, range

record: exact, in, gt, gte, lt, lte, range

start: exact, in, gt, gte, lt, lte, range

user: exact, in, gt, gte, lt, lte, range

Sorting Options

id, user, record, datatype, start, last_modified

© 2024 by CarrĂ© Technologies Inc.