Documentation

GlossaryApi extends AbstractApi
in package

Glossaries help to explain some specific terms or the ones often used in the project so that they can be properly and consistently translated.

Use API to manage glossaries or specific terms. Glossary export and import are asynchronous operations and shall be completed with sequence of API methods.

Table of Contents

Methods

clearTerms()  : mixed
Clear Glossary
create()  : Glossary|null
Add Glossary
createTerm()  : mixed
Add Term
delete()  : mixed
Delete Glossary
deleteTerm()  : mixed
Delete Term
download()  : DownloadFile|null
Download Glossary
export()  : GlossaryExport|null
Export Glossary
get()  : Glossary|null
Get Glossary
getExport()  : GlossaryExport|null
Check Glossary Export Status
getImport()  : GlossaryImport|null
Check Glossary Import Status
getTerm()  : Term|null
Get Term Info
import()  : GlossaryImport|null
Import Glossary
list()  : ModelCollection
List Glossaries
listTerms()  : ModelCollection|null
List Terms
update()  : Glossary|null
Edit Glossary Info
updateTerm()  : Term|null
Edit Term

Methods

createTerm()

Add Term

public createTerm(int $glossaryId, array<string|int, mixed> $data) : mixed
Parameters
$glossaryId : int
$data : array<string|int, mixed>

string $data[languageId] required
string $data[text] required
string $data[description]
string $data[partOfSpeech]
integer $data[translationOfTermId]

Tags
link

API Documentation

link

API Documentation Enterprise


        
On this page

Search results