Ekilex Term API

Järg olemasolevale API juhendile

Järgnevad termbaaside laadimist hõlbustavad lihtsad teenused. Vajalikud eeldused kasutamiseks:

API liidestuja individuaalne API võti ekilex-api-key päringu header-s.
crudRoleDataset päringu parameeter, mis spetsifitseerib sõnakogu, mille kasutaja õiguseid rakendatakse. See parameeter ei ole päringu andmete osa

Mõiste artikli lugemine

GET /api/term-meaning/details/{meaningId}/{datasetCode}

meaningId - mõiste ID, mille andmeid loetakse
datasetCode - sõnakogu piirang, mille järgi definitsioone ja termineid filtreeritakse

Päringu vastusena antakse klassile eki.ekilex.data.api.TermMeaning vastav andmestruktuur JSON formaadis

DELETE /api/meaning/delete

POST /api/term-meaning/save

Päringu keha vastab klassi eki.ekilex.data.api.TermMeaning struktuurile JSON formaadis. Näidis

Päring ilma terminiteta ei kvalifitseeru
Mõiste terminid saavad kõik korraga sama datasetCode andmeväljaga määratud sõnakogu
Kui sõnumis puudub meaningId, luuakse uus mõiste. Kui meaningId on määratud, uuendatakse vastavat mõistet

Kõik mõiste märkused ja sisemärkused, millel id puudub, luuakse ning seotakse vastava mõistega
Kui mõiste märkusel on avalikkus publicity määratud, siis see salvestatakse. Kui avalikkus on määramata, salvestatakse vaikimisi väärtus true
Kõik mõiste märkused, millel id on määratud, nende väärtust, keelt ja avalikkust uuendatakse
Kõik mõiste sisemärkused, millel id on määratud, neid ei uuendata
Mõiste valdkonna salvestamiseks on vajalik code ja origin. Kui mõistel puudub selline valdkond, siis seotakse vastav valdkond mõistega

Kõik terminid, millel puudub wordId, luuakse ning seotakse vastava mõistega
Kõik terminid, millel wordId on määratud, kuid keelendi märgendatud väärtust valuePrese ja keelt lang pole määratud, seotakse vastava mõistega
Kõik terminid, millel wordId on määratud koos keelendi märgendatud väärtuse valuePrese ja keelega lang, uuendatakse nende väärtustega ning seotakse vastava mõistega
Keelendi märgendamata väärtus value salvestatakse valuePrese põhjal automaatselt ja seda pole vaja määrata.

Termini keelendi tüüpide koodid on nimekirjas wordTypeCodes. Salvestamisel kontrollitakse, kas antud terminil on selline tüüp olemas. Kui ei ole, siis seotakse vastav keelendi tüüp terminiga
Termini väärtusoleku kood lexemeValueStateCode salvestatakse iga kord. Kui see on määramata, siis eemaldatakse varasemalt salvestatud kood
Kui terminil on avalikkus lexemePublicity määratud, siis see salvestatakse. Kui avalikkus on määramata, salvestatakse vaikimisi väärtus true

Kõik termini märkused ja kasutusnäited, millel id puudub, luuakse ning seotakse vastava terminiga
Kui termini märkusel on avalikkus publicity määratud, siis see salvestatakse. Kui avalikkus on määramata, salvestatakse vaikimisi väärtus true
Kui termini kasutusnäitel on avalikkus publicity määratud, siis see salvestatakse. Kui avalikkus on määramata, salvestatakse vaikimisi väärtus true
Kõik termini märkused ja kasutusnäited, millel id on määratud, nende väärtust, keelt ja avalikkust uuendatakse

Kõik seletused, millel definitionId puudub, luuakse ning seotakse vastava mõistega
Kõik seletused, millel definitionId on määratud, nende väärtust ja keelt uuendatakse

Mõiste märkustele, seletustele, terminitele, termini märkustele ja kasutusnäidetele on võimalik lisada allikaviiteid
Kui allikaviite id sourceLinkId puudub, siis luuakse uus viide. Kui see on määratud, siis uuendatakse allikaviidet
Allikaviite loomisel tuleb määrata allika id sourceId. Lisaks võib määrata siseviite väärtuse sourceLinkName
Allikaviite uuendamisel tuleb määrata allikaviite id sourceLinkId ja siseviite väärtus sourceLinkName

Kui mõiste viimase sisulise muudatuse aeg manualEventOn on määratud, siis see salvestatakse. Kui lisaks on määratud viimase sisulise muutja nimi manualEventBy, siis see salvestatakse (kui määramata, siis salvestatakse API kasutaja nimi)
Kui mõiste lisamise aeg firstCreateEventOn on määratud, siis see salvestatakse. Kui lisaks on määratud mõiste lisaja nimi firstCreateEventBy, siis see salvestatakse (kui määramata, siis salvestatakse API kasutaja nimi)
Kui mõiste lisamise aeg firstCreateEventOn ei ole määratud ja tegu on uue mõiste loomisega, siis mõiste loomise ajaks saab salvestamise aeg

Tähenduse siltide nimetused on nimekirjas tags. Salvestamisel kontrollitakse, kas antud tähendusel on selline silt olemas. Kui ei ole, siis seotakse vastav silt tähendusega
Ilmiku siltide nimetused on nimekirjas lexemeTags. Salvestamisel kontrollitakse, kas antud ilmikul on selline silt olemas. Kui ei ole, siis seotakse vastav silt ilmikuga