-
Notifications
You must be signed in to change notification settings - Fork 15
Ekilex API
Updated 21.09.2022
- For accessing API a security key is required. The API key can be acquired by everyone at Ekilex user profile page.
- There may be only one API key per user. Generating new API key replaces existing one.
- Put
ekilex-api-key: cd8c61505b17423282150624463fcaceinto the header of API request. - Since each API key is associated with a particular user, all data modification actions are logged by that name.
- CRUD operations can only be executed when either the key owner has admin rights or CRUD is granted by admin at Ekilex permissions page.
- The same permissions granting logic applies as in Ekilex
- API service URI-s start with "/api/**"
- All modification services return the same JSON structure with operation
success: true/falseflag with explanatory message
GET
/api/endpoints
Get technical specification of each service endpoint
*there are more - see endpoints spec
GET
/api/datasets
Example: datasets_result.json
GET
/api/classifiers/{classifierName}
Example: /api/classifiers/MORPH
-
classifierName- the classifier name constant. Currently exposed listings are for values:- LABEL_TYPE
- LANGUAGE
- DOMAIN
- GOVERNMENT_TYPE
- REGISTER
- FREQUENCY_GROUP
- GENDER
- POS
- MORPH
- DERIV
- WORD_TYPE
- ETYMOLOGY_TYPE
- MEANING_REL_TYPE
- LEX_REL_TYPE
- WORD_REL_TYPE
- FORM_REL_TYPE
- DISPLAY_MORPH
- PROCESS_STATE
- USAGE_AUTHOR_TYPE
- USAGE_TYPE
- VALUE_STATE
- POS_GROUP
- ASPECT
- DEFINITION_TYPE
- REGION
- SEMANTIC_TYPE
Example: classifiers_MORPH_result.json
GET
/api/domainorigins
GET
/api/domains/{origin}
Example: /api/domains/militerm
Example: domains_militerm_result.json
GET
/api/word/search/{word}
Example: /api/word/search/suuline
GET
/api/word/search/{word}/{datasets}
Example: /api/word/search/suuline/psv,qq2,ss1
-
word- word to search. Meta symbols*and?can be applied to make less specific search-
*- placeholder for any number of any symbols in search word -
?- placeholder for any one symbol in search word
-
-
datasets- optional. Comma delimited list of supported dataset codes. Only words with lexemes of specified datasets are retrieved or all if not specified
Example: lexsearch_suuline_result.json
GET
/api/word/details/{wordId}
Example: /api/word/details/216071
GET
/api/word/details/{wordId}/{datasets}
Example: /api/word/details/216071/psv,qq2,ss1
-
wordId- surrogate id of specific word record in Ekilex database -
datasets- optional. Comma delimited list of supported dataset codes. Only lexemes of specified datasets are retrieved or all if not specified
Example: worddetails_216071_result.json
GET
/api/paradigm/details/{wordId}
GET
/api/meaning/search/{word}
Example: /api/meaning/search/eu
GET
/api/meaning/search/{word}/{datasets}
Example: /api/meaning/search/eu/est,õtb
-
word- word to search. Meta symbols*and?can be applied to make less specific search-
*- placeholder for any number of any symbols in search word -
?- placeholder for any one symbol in search word
-
-
datasets- optional. Comma delimited list of supported dataset codes. Only meanings with lexemes of specified datasets are retrieved or all if not specified
Example: termsearch_eu_result.json
GET
/api/meaning/details/{meaningId}
Example: /api/meaning/details/384064
GET
/api/meaning/details/{meaningId}/{datasets}
Example: /api/meaning/details/384064/est,õtb
-
meaningId- surrogate id of specific meaning record in Ekilex database -
datasets- optional. Comma delimited list of supported dataset codes. Only lexemes of specified datasets are retrieved or all if not specified
Example: meaningdetails_384064_result.json
GET
/api/source/search/{sourceProperty}
Example: /api/source/search/aap-6
-
sourceProperty- value of source property to search. Meta symbols*and?can be applied to make less specific search-
*- placeholder for any number of any symbols in search word -
?- placeholder for any one symbol in search word
-
Example: sourcesearch_aap-6_result.json
GET
/api/public_word/{datasetCode}
Example: /api/public_word/eki
*there are more - see endpoints spec
POST
/api/word_type/create
- crudRoleDataset
- wordId
- classifierCode
POST
/api/word_relation/create
- crudRoleDataset
- wordId
- targetWordId
- relationTypeCode
- oppositeRelationTypeCode - optional, opposite relation is created if specified
POST
/api/word_forum/create
- wordId
- valuePrese
POST
/api/od_word_recommendation/create
- crudRoleDataset
- wordId
- valuePrese
POST
/api/word_forum/update
- id
- valuePrese
POST
/api/od_word_recommendation/update
- crudRoleDataset
- freeformId
- valuePrese
POST
/api/lexeme/delete
- crudRoleDataset
- lexemeId
POST
/api/word_type/delete
- crudRoleDataset
- wordId
- classifierCode
POST
/api/word_relation/delete
- crudRoleDataset
- relationId
NB! Unlike /api/word_relation/create, deleting has to be done twice. Relations are bidirectional, remember to delete the other end.
POST
/api/word_forum/delete
- wordForumId
POST
/api/od_word_recommendation/delete
- crudRoleDataset
- odWordRecommendationId
POST
/api/meaning_forum/create
- meaningId
- valuePrese
POST
/api/meaning_forum/update
- id
- valuePrese
POST
/api/meaning_forum/delete
- meaningForumId
POST
/api/lexeme_pos/create
- crudRoleDataset
- lexemeId
- classifierCode
POST
/api/lexeme_pos/delete
- crudRoleDataset
- lexemeId
- classifierCode