Metadata Types
Metadata types describe the value shape stored by form fields and returned by Studio APIs. Field metadata uses type for the concrete field type and dataType for the stored value category.
Use metadata types when a Studio script needs to read a record, build data for create or update calls, validate payload values, or inspect a field before deciding how to process it.
Type Categories
| Data Type | Field Types |
|---|---|
string | Text, Long Text, Assist Text, Serial Number, Search, Foreign Key, Select, Radio, Department, Organization, Member, Email, Link |
number | Number |
boolean | Switch |
date | Date, Time, Week, Month, Quarter, Year |
datetime | Datetime |
array | Multi Search, Multi Select, Checkbox Group, Multi Member, Image, Video, File, Audio |
object | Location |
Where Values Appear
Form record values are stored in record.data and keyed by field API name:
const record = await context.form.find({
formApiName: 'orders',
condition: {
logic: 'and',
children: [
{ field: 'order_no', operator: 'eq', value: 'SO-1001' },
],
},
});
const amount = record?.data.amount;
Field metadata is available through context.formSchema:
const amountField = await context.formSchema.field({
formApiName: 'orders',
fieldApiName: 'amount',
});
if (amountField?.dataType === 'number') {
// Handle numeric values.
}
Date Formatting
Studio SDK responses format temporal values by field metadata.
| Data Type | Returned Format |
|---|---|
date | YYYY-MM-DD |
datetime | YYYY-MM-DD HH:mm:ss |
Other data types are returned as their stored JSON-compatible values.