Glossaries

Concordance search in Glossaries

Required scopes: glossary (Read only).

post/glossaries/concordance

Request

Request body

sourceLanguageIdstring required

Source Language Identifier. Get via List Supported Languages

targetLanguageIdstring required

Target Language Identifier. Get via List Supported Languages

expressionsstring[] required

Expressions to search

userIdinteger nullable

Owner (user) whose glossaries to search. Only glossaries you own or manage are searched. Defaults to your own account.

Example request

{
  "sourceLanguageId": "en",
  "targetLanguageId": "de",
  "expressions": [
    "Welcome!",
    "Save as...",
    "View",
    "About..."
  ]
}

Response

Concordance Result Collection

Example response

{
  "data": [
    {
      "data": {
        "glossary": {
          "id": 2,
          "name": "Be My Eyes iOS's Glossary"
        },
        "concept": {
          "id": 2,
          "subject": "general",
          "definition": "Some definition",
          "note": "Any kind of note, such as a usage note, explanation, or instruction",
          "url": "Base URL",
          "figure": "Figure URL"
        },
        "sourceTerms": [
          {
            "id": 2,
            "userId": 6,
            "glossaryId": 6,
            "languageId": "fr",
            "text": "Voir",
            "description": "use for pages only (check screenshots)",
            "partOfSpeech": "verb",
            "status": "preferred",
            "type": "abbreviation",
            "gender": "masculine",
            "note": "Any kind of note, such as a usage note, explanation, or instruction",
            "url": "Base URL",
            "conceptId": 6,
            "lemma": "voir",
            "createdAt": "2019-09-23T07:19:47+00:00",
            "updatedAt": "2019-09-23T07:19:47+00:00"
          }
        ],
        "targetTerms": [
          {
            "id": 2,
            "userId": 6,
            "glossaryId": 6,
            "languageId": "fr",
            "text": "Voir",
            "description": "use for pages only (check screenshots)",
            "partOfSpeech": "verb",
            "status": "preferred",
            "type": "abbreviation",
            "gender": "masculine",
            "note": "Any kind of note, such as a usage note, explanation, or instruction",
            "url": "Base URL",
            "conceptId": 6,
            "lemma": "voir",
            "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.