Skip to main content

Get glossary

GET/api/glossary
Signed-in memberRead-only

POST /api/glossary/kept-terms adds every term or none. GET /api/glossary returns keptTerms, translations, entryLimit, and pairs: for each language pair the Organization translates, entryCount and a status of empty, not_synced, pending, synced, outdated (edited since its sync), unsupported, or failed with its error.

Read more: GlossarySource: GlossaryApiController#glossary(opens in new tab)

Response​

Success: 200

FieldTypeRequiredNotes
keptTermsarray of KeptTermViewOptional
keptTerms[].idstring (uuid)Optional
keptTerms[].termstringOptional
keptTerms[].creatorNamestringOptional
keptTerms[].createdAtstring (date-time)Optional
translationsarray of FixedTranslationViewOptional
translations[].idstring (uuid)Optional
translations[].sourceLanguagestringOptional
translations[].targetLanguagestringOptional
translations[].sourceTermstringOptional
translations[].targetTermstringOptional
translations[].creatorNamestringOptional
translations[].createdAtstring (date-time)Optional
pairsarray of GlossaryPairViewOptional
pairs[].sourceLanguagestringOptional
pairs[].targetLanguagestringOptional
pairs[].entryCountintegerOptional
pairs[].statusstringOptional
pairs[].errorstringOptional
pairs[].updatedAtstring (date-time)Optional
entryLimitintegerOptional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
401authentication_requiredno sessionAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400template_invalidAudiences area
400template_narratives_pathAudiences area
400template_language_not_targetedAudiences area
400invalid_release_languagesAudiences area
404audience_not_foundAudiences area
409audience_code_takenAudiences area
409audience_limitAudiences area
409audience_lastAudiences area
409audience_last_activeAudiences area
409audience_already_retiredAudiences area
409audience_not_retiredAudiences area
409audience_in_useAudiences area
409audience_not_presetAudiences area
404glossary_term_not_foundGlossary area
409glossary_term_takenGlossary area
409glossary_limitGlossary area
400invalid_release_scheduleReleases area
400invalid_upgrade_guide_urlReleases area
400invalid_previous_releaseReleases area
400invalid_fold_decisionReleases area
404release_not_foundReleases area
404release_note_not_foundReleases area
404folding_suggestion_not_foundReleases area
404linked_issue_not_foundReleases area
409release_status_conflictReleases area
409release_publishedReleases area
409release_emptyReleases area
409release_review_incompleteReleases area
409change_summary_requiredReleases area
409release_version_takenReleases area
409classification_changedReleases area
409change_not_releasableReleases area
409change_excludedReleases area
409release_note_render_failedReleases area
409release_notes_missingReleases area
409translations_not_readyReleases area
409linked_issue_status_changedReleases area

Request

bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
curl "http://localhost:8080/api/glossary" \
-b cookies.txt -c cookies.txt

Response

200

Example

{
  "keptTerms": [
    {
      "id": "<uuid>",
      "term": "<string>",
      "creatorName": "<string>",
      "createdAt": "<date-time>"
    }
  ],
  "translations": [
    {
      "id": "<uuid>",
      "sourceLanguage": "<string>",
      "targetLanguage": "<string>",
      "sourceTerm": "<string>",
      "targetTerm": "<string>",
      "creatorName": "<string>",
      "createdAt": "<date-time>"
    }
  ],
  "pairs": [
    {
      "sourceLanguage": "<string>",
      "targetLanguage": "<string>",
      "entryCount": 0,
      "status": "<string>",
      "error": "<string>",
      "updatedAt": "<date-time>"
    }
  ],
  "entryLimit": 0
}