Back to API Reference Home

POST v1/tbs/{tbGuid}/search

Looks up the given expression in the termbase.

Request information

Uri parameters

NameTypeDescriptionAdditional information
tbGuidGuidThe Guid of the termbase

Request body type

NameTypeDescription
ConditionSearchFilteringCondition (enum)Obligatory; Possible enum values: 0:BeginsWith; 1:Contains; 2:EndsWith; 3:ExactMatch; Specifies the desired matching behavior.
FilteringConditionsList<SearchMetaFilter>Optional, default value: null; Filtering conditions for meta fields.
ConditionSearchMetaFilteringConditions (enum)Obligatory; Possible enum values: 0:BeginsWith; 1:Contains; 2:Equals; 3:FilledIn; 4:IsNot; 5:NotFilledIn; Specifies the desired matching behavior.
MetaNameSearchMetaNames (enum)Obligatory; Possible enum values: 0:Client; 1:Domain; 2:Project; 3:Subject; The name of the meta field to filter by.
MetaValueStringObligatory; The value of the meta field to use for filtering.
LimitNullable`1Optional, default value: 120; The maximum number of entries to return.
SearchExpressionStringObligatory; The text to search for in Term Base entries.
TargetLanguageStringObligatory; The target language.

Request body formats

application/json

Sample:
{
  "FilteringConditions": [
    {
      "Condition": 0,
      "MetaName": 0,
      "MetaValue": "sample string 1"
    },
    {
      "Condition": 0,
      "MetaName": 0,
      "MetaValue": "sample string 1"
    },
    {
      "Condition": 0,
      "MetaName": 0,
      "MetaValue": "sample string 1"
    }
  ],
  "Limit": 1,
  "SearchExpression": "sample string 1",
  "Condition": 0,
  "TargetLanguage": "eng"
}

Response information

Response return type

NameTypeDescription
ListList<TBEntryModel>
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"
      }
    ]
  },
  {
    "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"
      }
    ]
  },
  {
    "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"
      }
    ]
  }
]