| Name | Type | Description | Additional information |
|---|---|---|---|
| tbGuid | Guid | The Guid of the termbase | |
| returnNewEntry | Boolean | Whether to return the newly created entry. Optional, default value: false. |
| Name | Type | Description |
|---|---|---|
| Client | String | Optional, default value: null; The client of the TB entry. |
| CustomMetas | TBCustomMetaItem[] | Optional, default value: null; An array of the TB entry's custom meta properties. |
| Name | String | Obligatory; The name of the custom meta property. |
| Value | String | Optional, default value: null; The value of the custom meta property. |
| Domain | String | Optional, default value: null; The domain of the TB entry. |
| Id | Int32 | Optional, default value: -1; The id of the TB entry. |
| Image | String | Optional, default value: null; The image url of the TB entry. |
| ImageCaption | String | Optional, default value: null; The image caption of the TB entry. |
| Languages | LanguageItem[] | Optional, default value: null; An array of the TB entry's languages. |
| CustomMetas | TBCustomMetaItem[] | Optional, default value: null; An array of the language's custom meta properties. |
| Name | String | Obligatory; The name of the custom meta property. |
| Value | String | Optional, default value: null; The value of the custom meta property. |
| Definition | String | Optional, default value: null; The definition of the language. |
| Id | Int32 | Optional, default value: -1; The id of the language. |
| Language | String | Obligatory; The code of the language. |
| NeedsModeration | Boolean | Optional, default value: null; Defines whether the language needs moderation. |
| TermItems | TermItem[] | Optional, default value: null; An array of the language's terms. |
| CaseSense | TermCaseSense (enum) | Optional, default value: null; Possible enum values: 0:Strict; 1:Near; 2:Insensitive; Defines the case sensitivity level of the term. |
| CustomMetas | TBCustomMetaItem[] | Optional, default value: null; An array of the term's custom meta properties. |
| Name | String | Obligatory; The name of the custom meta property. |
| Value | String | Optional, default value: null; The value of the custom meta property. |
| Example | String | Optional, default value: null; The example of the term. |
| GrammarGender | String | Optional, default value: null; The grammatical gender of the term. |
| GrammarNumber | String | Optional, default value: null; The grammatical number of the term. |
| GrammarPartOfSpeech | String | Optional, default value: null; The grammatical category of the term. |
| Id | Int32 | Optional, default value: -1; The id of the term. |
| IsForbidden | Boolean | Optional, default value: null; Defines whether the term is forbidden. |
| PartialMatch | TermPartialMatch (enum) | Optional, default value: null; Possible enum values: 0:Any; 1:Half; 2:None; 3:Custom; Defines the degree to which partial matches are allowed against this term. |
| PrefixBoundaries | Int32[] | Optional, default value: null; The prefix boundaries of the term. |
| Text | String | Obligatory; The text of the term. |
| WildText | String | Optional, default value: null; The '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. |
| Note | String | Optional, default value: null; The note of the TB entry. |
| Project | String | Optional, default value: null; The project of the TB entry. |
| Subject | String | Optional, default value: null; The subject of the TB entry. |
{
"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"
}
]
}