core-jvm
core2-jvm (latest)core-jvm
  • Home
  • Features
  • Examples
  • Spec
  • Guides
  • Sandbox
  • Step Studio
  • Step
    • Action
    • Behavior
    • External
    • Help
    • Link Handler
    • Navigation
    • Persist Async
    • Polling
    • Refresh On Change
    • Step Error
    • Summary
    • Upload
    • Validate Async
    • Schema
    • All Of Schema
    • Array Schema
    • Blob Schema
    • Boolean Schema
    • Const Schema
    • Integer Schema
    • Number Schema
    • Object Schema
    • One Of Schema
    • String Schema
    • Layout
    • Alert Layout
    • Box Layout
    • Button Layout
    • Columns Layout
    • Decision Layout
    • Form Layout
    • Heading Layout
    • Image Layout
    • Instructions Layout
    • List Layout
    • Loading Indicator Layout
    • Markdown Layout
    • Modal Layout
    • Paragraph Layout
    • Review Layout
    • Search Layout
    • Status List Layout
    • Action Response Body
    • Error Response Body
    • Flow Response
    • Search Response Body
    • Search Result
    • Align
    • Autocapitalization Type
    • Autocomplete Token
    • Context
    • Icon
    • Image
    • Size
These docs refer to the older 1.x release of Dynamic Flow.
Go to the latest docs

Step Error

Android - 8.25.0 iOS - 11539 Web - 2.5.0

Errors which should be displayed to the user when the step loads.

Properties

PropertyTypeRequiredDescription
errorStringNoA general error message, not related to any particular schema.
validationAnyNoError messages related to specific fields. The structure of this value must match the structure of the data to be validated. For example, given the following model: { "name": "A Person", "bankDetails": { "accountNumber": "31510604", "sortCode": "100000" } } A validation message for the "sortCode" field should be provided as follows: { "bankDetails": { "sortCode": "Please enter a valid sort code" } } Multiple validation messages can be returned at once, for example: { "name": "Please enter a full name", "bankDetails": { "sortCode": "Please enter a valid sort code" } }