Documentation Powered by ReDoc

ELEXIS Protocol for Dictionary Linking (1.0)

Download OpenAPI specification:Download

URL: https://elex.is/ License: Public Domain

This protocol is used by the ELEXIS Dictonary Matrix to provide linking between two dictionaries, it is implemented by services such as the Naisc system and the BabelNet linker. This protocol depends on the REST API for accessing dictionaries: https://elexis-eu.github.io/elexis-rest/

Submit a linking task

Link the sense of two dictionaries from two endpoints implemented the ELEXIS dictionary access protocol. This protocol returns on a success status, so that the result must be obtained with the /result query, and as such it is suitable for longer tasks, e.g., linking complete dictionaries

Request Body schema: application/json
source
required
object

The source dictionary

target
required
object

The target dictionary

configuration
object

An implementation specific configuration object

Responses

200

Success

403

It was not possible to start a task with this ID, for example it is already in use

500

Internal Server Error

501

The linking service does not support some part of the linking task specified.

post /submit
/submit

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "source":
    {},
  • "target":
    {
    },
  • "configuration":
    {
    }
}

Get the status of a linking task

Returns the status of a task submitted with /submit, including whether it has failed or completed

Request Body schema: text/plain
string

The ID as returned by submit

Responses

200

Success

404

The task ID was not found, for example, because it was not submitted

post /status
/status

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "state": "PROCESSING",
  • "message": "Still working away"
}

Get the result of a linking

Get the linking between two dictonaries. This should be called only after a submit and once the status has reached 'completed'

query Parameters
retain
boolean

Whether the server should retain this result or can delete all information related to this run

Request Body schema: text/plain
string

The ID as returned by submit

Responses

200

Success

404

The task ID was not found, for example, because it was not submitted or the result is not available yet

post /result
/result

Response samples

application/json
Copy
 Expand all Collapse all
[
  • [
    ]
]