About this resource

Representation of the definition of a RecordLinkField

Properties

Property Description Type
childClassifications A collection of all the classification Id's to which a child can be linked. This property allows you to limit which records can be used as a child by specifying to which classifications every record should be linked. A record is a valid child if it is classified in at least one of the specified classifications. Collection of guid items
childContentTypes A collection of all the Content types that a child can be. This property allows you to limit which records can be used as a child by specifying to which Content types every child record can be. Collection of string items
childHelpText Gets the help text of the linked child records in the language of the currently logged on user. string
childHelpTexts A collection of language-dependent help texts for linked child records. FieldPropertyHelpTextCollection
childLabel Gets the label of the linked child records in the language of the currently logged on user. string
childLabels A collection of language-dependent labels for linked child records. FieldPropertyLabelCollection
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)
linkClassifications A collection of all the classification Id's to which a record can be linked if RecordLinkType is set to NoParentChildRelationship. A record can be linked to if it is classified in at least one of the specified classifications. Collection of guid items
linkContentTypes A collection of all the Content types that a linked record can be. This property allows you to limit which records can be used as a link by specifying to which Content types every linked record can be. Collection of string items
linkType Gets the type of record link represented by the field. string (values: oneparentonechild, oneparentmanychildren, oneparentorderedchildren, manyparentsonechild, manyparentsmanychildren, manyparentsorderedchildren, noparentchildrelationship)
memberships Gets the memberships of a field. Collection of guid items
modifiedOn Modified on the specified date in UTC time. datetime
name Gets the name for this field. string
parentClassifications A collection of all the classification Id's to which a parent can be linked. This property allows you to limit which records can be used as a parent by specifying to which classifications every record should be linked. A record is a valid parent if it is classified in at least one of the specified classifications. Collection of guid items
parentContentTypes A collection of all the Content types that a parent can be. This property allows you to limit which records can be used as a parent by specifying which Content types every parent record can be. Collection of string items
parentHelpText Gets the help text of the linked parent records in the language of the currently logged on user. string
parentHelpTexts A collection of language-dependent help texts for linked parent records. FieldPropertyHelpTextCollection
parentLabel Gets the label of the linked parent records in the language of the currently logged on user. string
parentLabels A collection of language-dependent labels for linked parent records. FieldPropertyLabelCollection
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
showSummaryImage Indication if an image must be shown in the record selection list. boolean
sortIndex Gets the sorting index of this field. int32
storageMode Gets the storage mode of this field. string (values: none, nonemptyvalues, allvalues, logchanges)
summaryFieldId Id of the field that represents the record in a record selection list. guid
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-recordlinkfielddefinition' 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-RecordLinkFieldDefinition: createdby User Gets or sets the user that created this field definition.
GET modifiedby select-RecordLinkFieldDefinition: modifiedby User Gets or sets the user that last modified this field definition.