Loading...
Area: Optimizely Content Definitions API
Applies to versions: 3 and higher

Property Data Types

Recommended reading 

List all Property Data Types

get/api/episerver/v3.0/propertydatatypesList all property data types available in the system.

Common Property Data Types

What you want to create Data Type Editing experience Hints and tips
Plain short text PropertyString One row input Control the allowed length with the length validation.
Plain long text PropertyLongString with hint Textarea Text area Control the allowed length with the length validation.
Html PropertyXhtmlString A TinyMCE HTML editor  
Integer value PropertyNumber Control the min and max values with the range validation.
Double PropertyFloatNumber Control the min and max values with the range validation.
Date and time PropertyDate A date and time picker Control the min and max values with the range validation.
Boolean PropertyBoolean Checkbox  
Page type PropertyPageType   Filter items in a list, and so on.
BLOB PropertyBlob   Hold binary data (such as an image). Route to a BLOB with pattern {Url to content}/{BlobPropertyName}.
Language PropertyLanguage Checkbox list
Sort order PropertySortOrder Dropdown list
Category PropertyCategory Category picker Categories are managed in the admin UI.
Dropdown list PropertyDropDownList Dropdown list Available selections are managed from the admin UI.
Checkbox list PropertyCheckBoxList Checkbox list Available selections are managed from the admin UI.
List of strings PropertyStringList Control the allowed length with the itemLength validation. Control the number of strings with length validation. 
List of integers PropertyIntegerList Control the min and max values with the itemRange validation. Control the number of strings with length validation. 
List of doubles PropertyDoubleList Control the min and max values with the itemRange validation. Control the number of strings with length validation. 
List of dates PropertyDateList Control the min and max values with the itemRange validation. Control the number of strings with length validation. 

Working with other content

What you want to create Data Type Editing experience Hints and tips
Link to any content PropertyContentReference Content picker with
drag and drop support
Link to a page PropertyPageReference Content picker with
drag and drop support
 
Link to a media file of any type

PropertyContentReference
with hint MediaFile

Content picker with
drag and drop support
Link to any file in the media repository.
Link to an image

PropertyContentReference
with hint Image

Content picker with
drag and drop support
Lets an editor select content in the media repository by using baseType Image.
Link to a video

PropertyContentReference
with hint Video

Content picker with
drag and drop support
Lets an editor select content in the media repository by using baseType Video.
Link to a media file with the possibility to append information in the URL

PropertyUrl with hint
MediaFile, Image or Video

Content picker with
drag and drop support
Each link can be an item inside Optimizely, such as pages or media but also external URLs. Use URL instead of PropertyContentReference if you want to add information, such as query string parameters to control size.
Link to internal or external resource PropertyUrl Link dialog with drag and drop support  
Link to multiple external and/or internal resources PropertyLinkCollection Link collection editor with drag and drop support Control the number of links with length validation. 
Link to internal resources PropertyContentReferenceList Content picker with
drag and drop support
Control the number of content references with length validation. 
Include block data PropertyBlock and itemType with the name of the block type. 
Display content from other content PropertyContentArea

Validation

Read more about validation on the Content Types page.

Do you find this information helpful? Please log in to provide feedback.

Last updated: Nov 17, 2021

Recommended reading