About this resource

Representation of the definition of a MultiLineTextField

Properties

Property Description Type
aiEnabled Indicates whether to allow AI enhancement. boolean
createdOn Created on the specified date in UTC time. datetime
dataType Gets the data type of this field. string (values: none, singlelinetext, multilinetext, numeric, datetime, date, time, optionlist, duration, userlist, usergrouplist, html, json, classificationlist, recordlist, recordlink, languagelist, textlist, richcontent, hyperlinklist)
defaultValue Gets the default value of this field. string
enabledLanguages Enabled languages. Collection of guid items
helpText Gets the help text of this field. string
helpTexts A collection of HelpText items. HelpTextCollection
id Gets the identifier for this field. guid
indexed Gets the indicator if searching on this field is enabled. boolean
inlineStyle Gets a inline css style for this field. string
isReadOnly Indicates whether this field is read only. boolean
isRequired Indicates whether this field is required. boolean
isUniqueIdentifier Indicates whether this field is a unique identifier. boolean
label Gets the label of this field. string
labels A collection of Label items. LabelCollection
languageMode Gets the language mode of the field. string (values: single, multiple)
maximumLength The maximum length for the field. int32
memberships Gets the memberships of a field. Collection of guid items
minimumLength The minimum length for the field. int32
modifiedOn Modified on the specified date in UTC time. datetime
name Gets the name for this field. string
regularExpression A regular expression for validating the field. string
resetToDefaultFields Gets the fields that trigger this field to be reset back to its default value. This is only used if "ResetToDefaultTriggers" is set to "OnFieldChange". Collection of guid items
resetToDefaultTriggers Gets 'reset to default triggers' value of this field. Collection of string items (values: none, onnewfield, onload, onsave, onanyfilechange, onreclassifyrecord, onanychange, onfieldchange, onmasterfilechange, oncurrentfilechange, onfielddefinitionchanged, onduplicaterecord, onrecordstatuschange)
scope Gets the scope. string (values: recordcontentglobal, recordcontentclassdependent, recordcontentfloating, classificationprofileclassdependent, userglobal, filefiletypedependent, filefloating, indexertaskglobal, fileglobal, classificationprofilefloating, recordcontentcontenttypedependent)
scopeCategory Gets the scope category. string (values: record, file, classification, user, indexertask, metadatatemplate)
searchIndexRebuildRequired Gets the indicator if a search index rebuild is required. boolean
sortIndex Gets the sorting index of this field. int32
storageMode Gets the storage mode of this field. string (values: none, nonemptyvalues, allvalues, logchanges)
tag Gets a tag for this field containing extra information. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-multilinetextfielddefinition' and the value 'Tag' to your request. string
validation Gets the validation of this field. string
validationErrorMessage Gets the error message of this field. string
validationTrigger Gets the validation trtigger of this field. string (values: none, whenneeded, always)

Relations

Method Name Select-key Resource type Description
GET self Provides a link to this resource.
GET createdby select-MultiLineTextFieldDefinition: createdby User Gets or sets the user that created this field definition.
GET modifiedby select-MultiLineTextFieldDefinition: modifiedby User Gets or sets the user that last modified this field definition.