LogoLogo
  • Introduction
  • Features
  • Getting Started
    • Cortex User Guide
      • Organizations
      • Log in
      • Generate an API key
      • Make your first API request
      • Configure the org settings
      • Set up a data model
        • Create custom objects
        • Add custom properties
      • One-to-many relationships
      • Read and write data
      • Making a Request
      • Handling responses
      • Authentication
      • Two-factor authentication
      • Set third-party cookies
      • Connections
      • Upload files
      • Cortex iOS
      • Get started with Swift
      • Cortex service accounts
      • Cortex developer tools
      • Automated Account Notifications
  • Cortex API
    • Overview
    • Objects
      • Objects Overview
      • Organization
      • Account
      • Connections
      • Notifications
      • Stats
      • Logs
      • Export
      • Events
      • Room
    • Object Definition
      • Object Properties
        • Any
        • Binary
        • Boolean
        • Date
        • Document
        • File
        • Geometry
        • List
        • Number
        • ObjectId
        • Reference
        • String
    • Object Types
    • Access Control
    • Querying
      • Query Operators
      • Property Selection
      • Property Access
    • Aggregating
      • Aggregation Operators
    • Scripting
      • Script Types
      • Script Limits
      • ObjectId
      • CortexObject
        • Accounts
        • Views
      • Cursors
      • Operations
      • Script Modules
        • API Module
        • Base64 Module
        • Cache Module
        • Connections Module
        • Console Module
        • Consts Module
        • Counters Module
        • Crypto Module
        • HTTP Module
        • Logger Module
        • Notifications Module
        • Request Module
        • Response Module
        • SAML Module
        • Schemas Modules
        • Script Module
        • Session Module
        • Util.id Module
        • Util.ip Module
        • Util.paths Module
        • XML Module
        • Developer
        • Config
        • Renderer
        • SFTP
        • FTP
        • DB
          • Cursors
          • Driver
      • Static Methods
        • Accounts
        • Views
        • Cursors
      • Audit
      • Environments
      • HTTP Driver
      • Notifications
        • Firebase Cloud Messaging (FCM)
        • Tencent Push Notification Service Configuration
      • Televisit
      • Transforms
      • Localization
      • Available Javascript Libraries
    • Decorators
      • Runtime
        • Acl
        • As
        • Log
        • Profile
      • Static
        • Env
        • Job
        • Object
        • On
        • Policy
        • Route
        • Transform
        • Trigger
    • Expressions
      • Primer
      • Pipelines
      • Operators
      • Accumulators
      • Variables
      • Conditionals
      • Transforms
      • Triggers
      • On
      • Events
    • Faults
      • Fault Reference
  • Releases
    • Cortex Release Notes
      • Cortex API 2.28.3 (R3.4.6)
      • Cortex API 2.28.1 (R3.4.3)
      • Cortex API 2.27.2 (R3.4.1)
      • Cortex API 2.27.1 (R3.3.5)
      • SQL DB Connector 1.3.4 (R3.3.3)
      • Cortex API 2.26.2 (R3.3.1)
      • Cortex API 2.26.1 (R3.2.2)
      • Cortex API 2.26.0 (R3.2.1)
      • SQL DB Connector 1.3.3
      • Cortex API 2.25.0 (R3.1.1)
      • SQL DB Connector 1.3.2 (R3.1.0)
      • Cortex API 2.24.2 (R3.0.2)
      • SQL DB Connector 1.3.1 (R3.0.0)
      • Cortex API 2.24.1 (R2.3.3)
      • Cortex API 2.24.0 (R2.3.2)
      • SQL DB Connector 1.3.0 (R2.3.0)
      • Cortex API 2.23.0 (R2.2.4)
      • SQL DB Connector 1.2.0 (R2.2.0)
      • Cortex API 2.22.2 (R2.1.2)
      • Cortex API 2.22.1 and SQL DB Connector 1.1.1 (R2.0.1)
      • Cortex API 2.22.0
      • Cortex API 2.21.3
      • Cortex API 2.21.2
      • Cortex Web 4.16.0
      • Cortex Web 4.15.1
      • Cortex API 2.20.1
      • Cortex Web 4.14.0
      • Cortex Renderer 1.3.3
      • Cortex API 2.19.4
      • Cortex API 2.19.3 and Cortex Web 4.13.1
      • Cortex Renderer 1.3.2
      • Cortex API 2.19.1
      • Cortex API 2.18.0
      • Cortex API 2.17.6
      • Cortex API 2.17.5
      • Cortex API 2.17.4
      • Cortex API 2.17.3
      • Cortex API 2.17.2
      • Cortex API 2.17.1
      • Cortex API 2.16.0
      • Cortex API 2.15.9
      • Cortex API 2.15.8-1
      • Cortex 2.15.8
      • Cortex API 2.18.1
      • Cortex API 2.16.1
      • Cortex Renderer 1.3.1
      • Cortex Renderer 1.3.0
      • Cortex Renderer 1.2.2
      • Cortex Renderer 1.2.1
      • Cortex Renderer 1.2.0
    • Third-Party License Attribution

© 2025 Medable, Inc. All rights reserved.

On this page
  • Property Options
  • Property Validators

Was this helpful?

  1. Cortex API
  2. Object Definition
  3. Object Properties

String

Property Type: string‌

Strings represent a text value and can be configured with validators to limit input using regular expressions, and to enforce minimum and maximum lengths.‌

Property Options

Name

Type

Default

Description

trim

boolean

false

Trims the input string prior to validation but after writers.

lowercase

boolean

false

Lowercase the input string prior to validation but after writers.

uppercase

boolean

false

Uppercase the input string prior to validation but after writers.

localization

document

​Content

String localization options. Note: Although query matching for localized string values is possible, some cases (like $elemMatch) are not supported.

localization.enabled

boolean

false

Enable localization for the string values. Reading and writing to the property occurs on the current locale or the options below. When any string in an object definition is localized, a locales property document appears in the instance. Inside it, each localized string property is represented by an array of documents containing each locale and value that have been written ({locale: 'en_US', value: 'foo'}). Note: Once enabled, localization on a string cannot be disabled.

localization.valid

string[]

[]

Limits writing to a set of locales. Leaving this empty allows all org-level valid locales.

localization.fixed

string

''

Limit the native string property to reading and writing this locale. For reading, the fallback option still applies.

localization.strict

boolean

true

For reading and writing, throw an error if the selected locale is invalid. When false, the fallback option is used to attempt to return a fallback value.

localization.fallback

boolean

true

For reading, fallback to any usable locale value when none exists for the requested locale.

localization.acl

document[]

[]

A set of acl entries to apply to direct reading and writing of the locales-prefixed string property document array.

localization.readAccess

number

4 (read)

The resolved access level required to read the locales-prefixed property document array.

localization.writeAccess

number

6 (update)

The resolved access level required to update the locales-prefixed property document array.

localization.aclOverride

boolean

false

When true, the acl entries that are applied to the locales-prefixed property document array are applied from scratch to the caller, instead of augmenting their current access level.

‌

Property Validators

‌

Required name: required‌

String Validator name: string definition:

Name

Type

Default

Description

min

integer

0

Minimum length of string

max

integer

​Content

Maximum length of string

allowNull

boolean

false

Allow null values

allowEmpty

boolean

false

Allow 0-length strings

‌

Printable String Validator name: printableString definition:

Name

Type

Default

Description

anyFirstLetter

boolean

true

Allow the first letter of the string to be non-alphanumeric.

allowNumberAsFirstLetter

boolean

true

Allows a number as the first letter of the string.

min

integer

0

min length

max

integer

​Content

max length

‌

String Enum Validator name: stringEnum definition:

Name

Type

Default

Description

values

array

​Content

An array of possible entries.

‌

Email Validator name: email definition:

Name

Type

Default

Description

allowNull

boolean

true

Allow blank or null entries

‌

Locale Validator name: locale definition:

Name

Type

Default

Description

allowNull

boolean

false

Allow blank or null entries

‌

Password Strength Validator name: passwordStrength definition:

Name

Type

Default

Description

minScore

integer

​Content

The minimum password score requirement (based on zxcvbn)

‌

Phone Number Strength Validator name: phoneNumber definition:

Name

Type

Default

Description

allowNull

boolean

false

Allow null entries.

requireMobile

boolean

false

If true, requires the number to be a mobile number.

allowedCountries

array or strings

​Content

List of allowed countries

‌

URL Validator name: url definition:

Name

Type

Default

Description

allowNull

boolean

false

Allow null values

allowEmpty

boolean

false

Allow 0-length strings

webOnly

boolean

true

Url must be a web url, beginning with http:// or https://

webSecure

boolean

​Content

Applies when webOnly is true. If present, url must either be https:// (true) or http:// (false). Omitting this property allows either.

‌

Pattern Validator name: pattern definition:

Name

Type

Default

Description

allowNull

boolean

false

Allow null values

allowEmpty

boolean

false

Allow 0-length strings

pattern

regex

​Content

The regex pattern to test against the incoming string value

Last updated 3 years ago

Was this helpful?