CRcrowdin
Glossaries

Add Term

Required scopes: glossary (Read and Write).

Note: If conceptId is not specified, a new concept will be automatically created for the term.

post/glossaries/{glossaryId}/terms

Request

Path parameters

glossaryIdinteger required

Glossary Identifier. Get via List Glossaries

Request body

languageIdstring required

Term Language Identifier. Get via List Supported Languages

textstring required

Term

descriptionstring

Term description

partOfSpeech'adjective' | 'adposition' | 'adverb' | 'auxiliary' | 'coordinating conjunction' | 'determiner' | 'interjection' | 'noun' | 'numeral' | 'particle' | 'pronoun' | 'proper noun' | 'subordinating conjunction' | 'verb' | 'other'

Term part of speech

status'preferred' | 'admitted' | 'not recommended' | 'obsolete' | 'draft'

Term status

type'full form' | 'acronym' | 'abbreviation' | 'short form' | 'phrase' | 'variant'

Term type

gender'masculine' | 'feminine' | 'neuter' | 'other'

Gender

notestring

Any kind of note, such as a usage note, explanation, or instruction

urlstring

Base URL

conceptIdinteger

Defines whether to add translation to the existing term. Get concept_id via List Terms or via List Concepts

translationOfTermIdinteger

Defines whether to add translation to the existing term. Get id via List Terms

fieldsEnterpriseAdditionalFields

Fields. Keys get via List Fields

Example request

{
  "languageId": "fr",
  "text": "Voir",
  "description": "use for pages only (check screenshots)",
  "partOfSpeech": "verb",
  "status": "preferred",
  "type": "abbreviation",
  "gender": "masculine",
  "fields": {
    "some-field-1": "some value 1",
    "some-field-2": 12,
    "some-field-3": true,
    "some-field-4": [
      "en",
      "ja"
    ]
  }
}

Response

Term was successfully created

Example response

{
  "data": {
    "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",
    "fields": {
      "some-field-1": "some value 1",
      "some-field-2": 12,
      "some-field-3": true,
      "some-field-4": [
        "en",
        "ja"
      ]
    }
  }
}

Changes

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