Back to API Reference Home

POST v1/tbs/{tbGuid}/entries/create?returnNewEntry={returnNewEntry}

Creates a termbase entry in the TB specified by a Guid.

Request information

Uri parameters

NameTypeDescriptionAdditional information
tbGuidGuidThe Guid of the termbase
returnNewEntryBooleanWhether to return the newly created entry. Optional, default value: false.

Request body type

NameTypeDescription
IdInt32Optional, default value: -1; The id of the TB entry.
ClientStringOptional, default value: null; The client of the TB entry.
CreatedDateTimeObligatory; The creation date of the TB entry.
CreatorStringObligatory; The creator of the TB entry.
DomainStringOptional, default value: null; The domain of the TB entry.
ImageCaptionStringOptional, default value: null; The image caption of the TB entry.
ImageStringOptional, default value: null; The image url of the TB entry.
LanguagesLanguageItem[]Optional, default value: null; An array of the TB entry's languages.
LanguageStringObligatory; The code of the language.
DefinitionStringOptional, default value: null; The definition of the language.
IdInt32Optional, default value: -1; The id of the language.
NeedsModerationBooleanOptional, default value: null; Defines whether the language needs moderation.
TermItemsTermItem[]Optional, default value: null; An array of the language's terms.
CaseSenseTermCaseSense (enum)Optional, default value: null; Possible enum values: 0:Strict; 1:Near; 2:Insensitive; Defines the case sensitivity level of the term.
ExampleStringOptional, default value: null; The example of the term.
GrammarGenderStringOptional, default value: null; The grammatical gender of the term.
GrammarNumberStringOptional, default value: null; The grammatical number of the term.
GrammarPartOfSpeechStringOptional, default value: null; The grammatical category of the term.
IdInt32Optional, default value: -1; The id of the term.
IsForbiddenBooleanOptional, default value: null; Defines whether the term is forbidden.
PartialMatchTermPartialMatch (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.
PrefixBoundariesInt32[]Optional, default value: null; The prefix boundaries of the term.
TextStringObligatory; The text of the term.
WildTextStringOptional, default value: null; The 'wild' text of the term. It contains wildcards denoting prefix-boundaries.
CustomMetasTBCustomMetaItem[]Optional, default value: null; An array of the term's custom meta properties.
NameStringObligatory; The name of the custom meta property.
ValueStringOptional, default value: null; The value of the custom meta property.
CustomMetasTBCustomMetaItem[]Optional, default value: null; An array of the language's custom meta properties.
NameStringObligatory; The name of the custom meta property.
ValueStringOptional, default value: null; The value of the custom meta property.
ModifiedDateTimeObligatory; The date of the TB entry's last modification.
ModifierStringOptional, default value: null; The last modifier of the TB entry.
NoteStringOptional, default value: null; The note of the TB entry.
ProjectStringOptional, default value: null; The project of the TB entry.
SubjectStringOptional, default value: null; The subject of the TB entry.
CustomMetasTBCustomMetaItem[]Optional, default value: null; An array of the TB entry's custom meta properties.
NameStringObligatory; The name of the custom meta property.
ValueStringOptional, default value: null; The value of the custom meta property.

Request body formats

application/json

Sample:
{
  "Id": 0,
  "Client": "client",
  "Created": "2015-08-28T14:02:31.22Z",
  "Creator": "Built-in administrator",
  "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"
        }
      ]
    }
  ],
  "Modified": "2015-08-28T14:02:31.22Z",
  "Modifier": "Built-in administrator",
  "Note": "note",
  "Project": "project",
  "Subject": "subject",
  "CustomMetas": [
    {
      "Name": "name",
      "Value": "value"
    },
    {
      "Name": "name",
      "Value": "value"
    },
    {
      "Name": "name",
      "Value": "value"
    }
  ]
}