conversion service

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
ConversionResourceImpl
  • /rest/cancelTask
  • /rest/createTask
  • /rest/createTaskWithPriority
  • /rest/downloadData
  • /rest/findTask
  • /rest/getFilters
  • /rest/getStats
  • /rest/getTask
  • /rest/listTaskIds
  • /rest/listTasks
  • /rest/reloadConfiguration
  • /rest/sanity
  • /rest/startExecutors
  • /rest/startTask
  • /rest/stopExecutors
  • /rest/terminateTask
  • /rest/uploadData
  • /rest/version
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET

Data Types

JSON

type description
Filter
FilterMixin
SanityResponse Response to a sanity request
SanityState Enumeration of all sanity states the service can be in.
  • OK: Service is running ok, all docfetchers are ok.
  • WARNING: Service encountered warnings.
  • ERROR: Service encountered errors.
  • FATAL: Service is in a critical state and most likely stopped to work properly.
StatsResponse Response to a stats request
Task
TaskMixin
TaskState Possible states of tasks in the executor state machine and in the service.
VersionResponse Response to a request of the version of the API, contains major and minor of the version.