Access Methods

G​E​T

URL Parameters

None

Request Body

None

Response

A JSON object with properties describing Lingo4G and the active project. An example response can look like this:

{
  "product": "Lingo4G",
  "version": "2.0.0",
  "build": "2023-01-31 10:12 229764",
  "projectId": "imdb",
  "license": {
    "expires": "never",
    "maintenanceExpires": "2023-03-21 10:03:51 UTC",
    "maxDocumentsInScope": "250.00k",
    "maxIndexedContentLength": "25.00GB"
  }
}

The license section contains validity period and limits information consolidated across all available license files. This section will show the most favourable values (the latest expiration date, the largest limit) across all loaded license files.

Errors

none

Examples

The /about endpoint requires a basic HTTP GET request with no parameters. Here is an outline of such a request:

GET /api/v2/about HTTP/1.1
Content-Type: application/json

You can use the curl command to send such a request (assuming there is a Lingo4G server working at localhost:​8080):

curl http://localhost:8080/api/v2/about

The server could return the following HTTP response (verbose headers included):

HTTP/1.1 200 OK
content-length: 301
content-type: application/json;charset=utf-8

{
  "product" : "Lingo4G",
  "version" : "2.0.0-SNAPSHOT",
  "build" : "2023-04-24 11:14 b7197f",
  "projectId" : "arxiv",
  "license" : {
    "expires" : "never",
    "maintenanceExpires" : "never",
    "maxDocumentsInScope" : "unlimited",
    "maxIndexedContentLength" : "unlimited"
  }
}