DTXS API REST API Miscellaneous

Miscellaneous

Endpoints that are primarily used for getting some type of basic information.

GET /

A basic response from a server.

cURL example

curl \
  -X GET \
  -H 'Content-Type: application/json' \
  -d '' \
  https://dtxs-server.example.com

Responses

Code Description Return value Example
200 Success. Returns a message about the server being ready.
400 Unknown error.

GET /server-info

Returns the server information

cURL example

curl \
  -X GET \
  -H 'Content-Type: application/json' \
  -d '' \
  https://dtxs-server.example.com/server-info

Responses

Code Description Return value Example
200 Success. Server information See example
400 Unknown error.

Server information response example

{
  'buildInfo': {
    'compilationTime': 'unknown'
  }
  'apiVersion': 'v1.0'
  'uptime': 3600
}

GET /ontologies

Returns the list of available ontologies

curl \
  -X GET \
  -H 'Content-Type: application/json' \
  -d '' \
  https://dtxs-server.example.com/ontologies

Responses

Code Description Return value Example
200 Success. List of ontologies See example
400 Unknown error.

Ontologies response example

{
}

GET /classes

Returns the list of available classes

curl \
  -X GET \
  -H 'Content-Type: application/json' \
  -d '' \
  https://dtxs-server.example.com/classes

Responses

Code Description Return value Example
200 Success. List of classes See example
400 Unknown error.

Classes response example

{
}
(C) wai.blue | Rendered using GuideVis