Glossaries

List Concepts

Required scopes: glossary (Read only).

Returns a list of concepts in the glossary. A concept groups the terms that mean the same thing in different languages.

get/glossaries/{glossaryId}/concepts

Request

Path parameters

glossaryIdinteger required

Glossary Identifier. Get via List Glossaries

Query parameters

orderBy'id' | 'subject' | 'definition' | 'note' | 'createdAt' | 'updatedAt'

Read more about sorting rules

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

Response

Concepts list

Example response

{
  "data": [
    {
      "data": {
        "id": 2,
        "userId": 6,
        "glossaryId": 6,
        "subject": "general",
        "definition": "Some definition",
        "translatable": true,
        "note": "Any kind of note, such as a usage note, explanation, or instruction",
        "url": "www.example.com",
        "figure": "www.example.com/image.png",
        "languagesDetails": [
          {
            "languageId": "en",
            "userId": 12,
            "definition": "Some definition",
            "note": "Some note",
            "createdAt": "2019-09-19T14:14:00+00:00",
            "updatedAt": "2019-09-19T14:14:00+00:00"
          }
        ],
        "createdAt": "2019-09-23T07:19:47+00:00",
        "updatedAt": "2019-09-23T07:19:47+00:00"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.