• DOCUMENTATION
  • WORKATO BLOG
  • PRODUCT BLOG
  • Return to Workato
  • Log in
  • ☰
  • Community/Discussions
Solution home Partners & Developers Developer

Schema Definition

Modified on: Tue, Oct 1, 2019 at 7:37 AM


Table of properties of a schema definition


NameDescription TypeSupported Values
nameThe name of this field. For example `id` or `created_at`.
This should match the API name of the field

string
label The label name of this field. For example 'ID' or 'Created at'.
This is what you see in the recipe.
string 
typeThe data type of this field. Default value is string
stringstring
integer

date_time
boolean
object
array
control_typeThe input field type to expose in a recipe.
stringtext
text-area
date
date_time
checkbox
phone
email
number
url
select
hintHint to be added to a field (only shown as an input fieldstring 
optionalDefine whether this field is a required field (when being used as an input field). Defaults to false.booleantrue
false
propertiesUsed to specify the contents of an array or object fields.
array 
pick_list
List of name and value pairs for select control. Required when control_type is select
E.g:  
"pick_list":[
  ["Root","111390"],
  ["Recycle Bin","235611"]
]


array


Sample schema

   

[
  {
    "name": "status", 
    "type": "string", 
    "label": "Status",
    "control_type": "text"
  },
  { 
    "name": "birth_date", 
    "type": "date_time", 
    "label": "Birth date", 
    "control_type": "date_time", 
    "optional": true
  },
  {
    "name": "gender", 
    "type": "string", 
    "label": "Gender",  
    "control_type": "select",
    "pick_list": [
      ["Male", "M"], 
      ["Female", "F"] 
    ]
  },
  {
    "name":"contact_info",
    "type":"object",
    "label":"Contact information",
    "hint":"Phone number, email, etc",
    "properties":[
      {
        "name": "phone",
        "type":  "string",
        "label": "Phone",
        "control_type": "phone",
        "optional": true
      },
      {
        "name": "email",
        "type": "string",
        "label": "Email address",
        "control_type": "email",
        "optional": true
      }
    ]
  }
]

   

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Related Articles

    Still can't find your solution?

    Visit our forums to search for answers, or post your own questions.

    Documentation
    Developer's Library
    Tutorials
    eBooks
    Product Hour
    Product Blog
    Workato Blog
    Product updates
    Customer Stories
    © Workato 2020   Privacy   Terms   +1 (844) 469-6752
    • Documentation
    • Workato Blog
    • Product Blog
    • Solutions
    • Forums
    • Tickets
    • Log in
    • Return to Workato