Back to API Reference Home

GET v1/tbs/{tbGuid}/entries/{entryId}

Gets the termbase entry specified by a TB Guid and an entry id.

Request information

Uri parameters

NameTypeDescriptionAdditional information
tbGuidGuidThe Guid of the termbase
entryIdInt32The id of the termbase entry

Response information

Response return type

NameTypeDescription
ClientStringThe client of the TB entry.
CreatedDateTimeThe creation date of the TB entry.
CreatorStringThe creator of the TB entry.
CustomMetasTBCustomMetaItem[]An array of the TB entry's custom meta properties.
NameStringThe name of the custom meta property.
ValueStringThe value of the custom meta property.
DomainStringThe domain of the TB entry.
IdInt32The id of the TB entry.
ImageStringThe image url of the TB entry.
ImageCaptionStringThe image caption of the TB entry.
LanguagesLanguageItem[]An array of the TB entry's languages.
CustomMetasTBCustomMetaItem[]An array of the language's custom meta properties.
NameStringThe name of the custom meta property.
ValueStringThe value of the custom meta property.
DefinitionStringThe definition of the language.
IdInt32The id of the language.
LanguageStringThe code of the language.
NeedsModerationBooleanDefines whether the language needs moderation.
TermItemsTermItem[]An array of the language's terms.
CaseSenseTermCaseSense (enum)Possible enum values: 0:Strict; 1:Near; 2:Insensitive; Defines the case sensitivity level of the term.
CustomMetasTBCustomMetaItem[]An array of the term's custom meta properties.
NameStringThe name of the custom meta property.
ValueStringThe value of the custom meta property.
ExampleStringThe example of the term.
GrammarGenderStringThe grammatical gender of the term.
GrammarNumberStringThe grammatical number of the term.
GrammarPartOfSpeechStringThe grammatical category of the term.
IdInt32The id of the term.
IsForbiddenBooleanDefines whether the term is forbidden.
PartialMatchTermPartialMatch (enum)Possible enum values: 0:Any; 1:Half; 2:None; 3:Custom; Defines the degree to which partial matches are allowed against this term.
PrefixBoundariesInt32[]The prefix boundaries of the term.
TextStringThe text of the term.
WildTextStringThe 'wild' text of the term. It contains wildcards denoting prefix-boundaries. It will not be taken into consideration when adding new entries to a term base.
ModifiedDateTimeThe date of the TB entry's last modification. An OptimisticConcurrencyError occurs during the update action if it does not match the existing entry's Modified parameter.
ModifierStringThe last modifier of the TB entry.
NoteStringThe note of the TB entry.
ProjectStringThe project of the TB entry.
SubjectStringThe subject of the TB entry.

Response body formats

application/json

Sample:
{
  "Created": "2015-08-28T14:02:31.22Z",
  "Creator": "Built-in administrator",
  "Modified": "2015-08-28T14:02:31.22Z",
  "Modifier": "Built-in administrator",
  "Id": 0,
  "Client": "client",
  "Domain": "domain",
  "ImageCaption": "image caption",
  "Image": "image url",
  "Languages": [
    {
      "Language": "ger",
      "Definition": "definition",
      "Id": 0,
      "NeedsModeration": true,
      "TermItems": [
        {
          "CaseSense": 2,
          "Example": "example",
          "GrammarGender": "",
          "GrammarNumber": "",
          "GrammarPartOfSpeech": "",
          "Id": 0,
          "IsForbidden": false,
          "PartialMatch": 2,
          "PrefixBoundaries": [
            1
          ],
          "Text": "text",
          "WildText": "wild text",
          "CustomMetas": [
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            }
          ]
        },
        {
          "CaseSense": 2,
          "Example": "example",
          "GrammarGender": "",
          "GrammarNumber": "",
          "GrammarPartOfSpeech": "",
          "Id": 0,
          "IsForbidden": false,
          "PartialMatch": 2,
          "PrefixBoundaries": [
            1
          ],
          "Text": "text",
          "WildText": "wild text",
          "CustomMetas": [
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            }
          ]
        },
        {
          "CaseSense": 2,
          "Example": "example",
          "GrammarGender": "",
          "GrammarNumber": "",
          "GrammarPartOfSpeech": "",
          "Id": 0,
          "IsForbidden": false,
          "PartialMatch": 2,
          "PrefixBoundaries": [
            1
          ],
          "Text": "text",
          "WildText": "wild text",
          "CustomMetas": [
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            }
          ]
        }
      ],
      "CustomMetas": [
        {
          "Name": "name",
          "Value": "value"
        },
        {
          "Name": "name",
          "Value": "value"
        },
        {
          "Name": "name",
          "Value": "value"
        }
      ]
    },
    {
      "Language": "ger",
      "Definition": "definition",
      "Id": 0,
      "NeedsModeration": true,
      "TermItems": [
        {
          "CaseSense": 2,
          "Example": "example",
          "GrammarGender": "",
          "GrammarNumber": "",
          "GrammarPartOfSpeech": "",
          "Id": 0,
          "IsForbidden": false,
          "PartialMatch": 2,
          "PrefixBoundaries": [
            1
          ],
          "Text": "text",
          "WildText": "wild text",
          "CustomMetas": [
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            }
          ]
        },
        {
          "CaseSense": 2,
          "Example": "example",
          "GrammarGender": "",
          "GrammarNumber": "",
          "GrammarPartOfSpeech": "",
          "Id": 0,
          "IsForbidden": false,
          "PartialMatch": 2,
          "PrefixBoundaries": [
            1
          ],
          "Text": "text",
          "WildText": "wild text",
          "CustomMetas": [
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            }
          ]
        },
        {
          "CaseSense": 2,
          "Example": "example",
          "GrammarGender": "",
          "GrammarNumber": "",
          "GrammarPartOfSpeech": "",
          "Id": 0,
          "IsForbidden": false,
          "PartialMatch": 2,
          "PrefixBoundaries": [
            1
          ],
          "Text": "text",
          "WildText": "wild text",
          "CustomMetas": [
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            }
          ]
        }
      ],
      "CustomMetas": [
        {
          "Name": "name",
          "Value": "value"
        },
        {
          "Name": "name",
          "Value": "value"
        },
        {
          "Name": "name",
          "Value": "value"
        }
      ]
    },
    {
      "Language": "ger",
      "Definition": "definition",
      "Id": 0,
      "NeedsModeration": true,
      "TermItems": [
        {
          "CaseSense": 2,
          "Example": "example",
          "GrammarGender": "",
          "GrammarNumber": "",
          "GrammarPartOfSpeech": "",
          "Id": 0,
          "IsForbidden": false,
          "PartialMatch": 2,
          "PrefixBoundaries": [
            1
          ],
          "Text": "text",
          "WildText": "wild text",
          "CustomMetas": [
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            }
          ]
        },
        {
          "CaseSense": 2,
          "Example": "example",
          "GrammarGender": "",
          "GrammarNumber": "",
          "GrammarPartOfSpeech": "",
          "Id": 0,
          "IsForbidden": false,
          "PartialMatch": 2,
          "PrefixBoundaries": [
            1
          ],
          "Text": "text",
          "WildText": "wild text",
          "CustomMetas": [
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            }
          ]
        },
        {
          "CaseSense": 2,
          "Example": "example",
          "GrammarGender": "",
          "GrammarNumber": "",
          "GrammarPartOfSpeech": "",
          "Id": 0,
          "IsForbidden": false,
          "PartialMatch": 2,
          "PrefixBoundaries": [
            1
          ],
          "Text": "text",
          "WildText": "wild text",
          "CustomMetas": [
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            },
            {
              "Name": "name",
              "Value": "value"
            }
          ]
        }
      ],
      "CustomMetas": [
        {
          "Name": "name",
          "Value": "value"
        },
        {
          "Name": "name",
          "Value": "value"
        },
        {
          "Name": "name",
          "Value": "value"
        }
      ]
    }
  ],
  "Note": "note",
  "Project": "project",
  "Subject": "subject",
  "CustomMetas": [
    {
      "Name": "name",
      "Value": "value"
    },
    {
      "Name": "name",
      "Value": "value"
    },
    {
      "Name": "name",
      "Value": "value"
    }
  ]
}