trckpd

API

This document tabulates all available the REST APIs. The APIs are classified in two groups -

  1. Index management : APIs needed to create, update, delete index and box.
  2. User application : APIs needed for user facing application.

@See Entity

API Description Classification
GET _/job/ Returns all jobs. System
POST _/job/ Creates a job with a generated id, id is UUID. System
GET _/job/{id} Returns the job with the specified id. System
PUT _/job/{id} Cancels the job with the specified id. System
GET _/doc/range={f,t} Returns a list documents whose names are in the specified range System
GET _/search/term={t}&source={s} Returns the search result for the term User
GET _/doc/{id} Returns the document with the specified id. User