Translation Glossary

Get, add, modify, and delete entries from the translation glossary. The translation glossary is used to specify entries and how they should be translated per language. These endpoints are only available for sites with multiple languages.

GET /translation_glossary/entries

List of glossary entries. This endpoint currently returns all entries in the glossary.

PUT /translation_glossary/entries

Add, modify, and/or delete entries for the Translation Glossary.

Request Body

entries — Optional — array of objects

List of entries to add and/or modify.

entryid— Optional integer. The entryid of an existing entry that is being edited. If unspecified or set to null then the entry will be considered new. The response body includes the same entries that were added/modified in the same order. Any new entries will have the entryid included in the response.
translations— Required array of objects. The translations per language of the entry. Each translation has two required fields: `langid` (string) and `text` (string). If an entryid is provided, all translations of the entry will be overwritten with the given new list of translations. Each entry must contain an English (`en`) translation.

Example

{
    "entries": [
        {
            "entryid": 1,
            "translations": [
                {
                    "langid": "en",
                    "text": "Hello"
                },
                {
                    "langid": "es",
                    "text": "Hola"
                }
            ]
        },
        {
            "translations": [
                {
                    "langid": "en",
                    "text": "New"
                },
                {
                    "langid": "es",
                    "text": "Nuevo"
                }
            ]
        }
    ]
}

deletedEntryids — Optional — array of integers

List of entryids that will be deleted.

Example

{
    "deletedEntryids": [
        123,
        456
    ]
}

Response

Status: 200 OK

{
    "entries": [
        {
            "entryid": 1,
            "translations": [
                {
                    "langid": "en",
                    "text": "Hello"
                },
                {
                    "langid": "es",
                    "text": "Hola"
                }
            ]
        },
        {
            "entryid": 2,
            "translations": [
                {
                    "langid": "en",
                    "text": "New"
                },
                {
                    "langid": "es",
                    "text": "Nuevo"
                }
            ]
        }
    ],
    "deletedEntryids": [
        123,
        456
    ]
}

DELETE /translation_glossary/entries/{entryid}

Delete an entry from the Translation Glossary. If you want to delete individual translations of an entry, use the PUT /translation_glossary/entries endpoint and specify a new list of translations that you want.

API Index

Single Sign-on

Webhooks

Approvals

Authentication

Badges

Content Hierarchy

Media

Guides

Comments

Work Log

Step Forms

Suggest

Search

Tags

Teams

Translation Glossary

Users

Wikis

User View History

External Training Modules

Periodic Review

Reference Implementations

Official Apps

Third-party Apps

Third-party Libraries

API Versions

Translation Glossary

GET /translation_glossary/entries

Response

PUT /translation_glossary/entries

Request Body

Response

DELETE /translation_glossary/entries/{entryid}

Route Parameters

Response