Metadata that controls how a database property behaves.
Each database property schema object has at least one key which is the property type. This type contains behavior of this property. Possible values of this key are "title"
, "rich_text"
, "number"
, "select"
, "multi_select"
, "date"
, "people"
, "files"
, "checkbox"
, "url"
, "email"
, "phone_number"
, "formula"
, "relation"
, "rollup"
, "created_time"
, "created_by"
, "last_edited_time"
, "last_edited_by"
.
Each database must have exactly one database property schema object of type "title"
. This database property controls the title that appears at the top of the page when the page is opened. Title database property objects have no additional configuration within the title
property.
Text database property schema objects have no additional configuration within the rich_text
property.
Number database property schema objects optionally contain the following configuration within the number
property.
format
optional string
(enum) How the number is displayed in Notion. Potential values include: number
, number_with_commas
, percent
, dollar
, canadian_dollar
, euro
, pound
, yen
, ruble
, rupee
, won
, yuan
, real
, lira
, rupiah
, franc
, hong_kong_dollar
, new_zealand_dollar
, krona
, norwegian_krone
, mexican_peso
, rand
, new_taiwan_dollar
, danish_krone
, zloty
, baht
, forint
, koruna
, shekel
, chilean_peso
, philippine_peso
, dirham
, colombian_peso
, riyal
, ringgit
, leu
, argentine_peso
, uruguayan_peso
, singapore_dollar
. "percent"
Select database property schema objects optionally contain the following configuration within the select
property:
options
optional array of select option objects. Sorted list of options available for this property. Property Type Description Example value name
string
Name of the option as it appears in Notion. "Fruit"
color
optional string
(enum) Color of the option. Possible values include: default
, gray
, brown
, orange
, yellow
, green
, blue
, purple
, pink
, red
. "red"
Multi-select database property schema objects optionally contain the following configuration within the multi_select
property:
name
string
Name of the option as it appears in Notion. "Fruit"
color
optional string
(enum) Color of the option. Possible values include: default
, gray
, brown
, orange
, yellow
, green
, blue
, purple
, pink
, red
. "red"
Date database property schema objects have no additional configuration within the date
property.
People database property schema objects have no additional configuration within the people
property.
File database property schema objects have no additional configuration within the file
property.
Checkbox database property schema objects have no additional configuration within the checkbox
property.
URL database property schema objects have no additional configuration within the url
property.
Email database property schema objects have no additional configuration within the email
property.
Phone number database property schema objects have no additional configuration within the phone_number
property.
Formula database property schema objects contain the following configuration within the formula
property:
expression
string
Formula to evaluate for this property. You can read more about the syntax for formulas in the help center. "if(prop(\"In stock\"), 0, prop(\"Price\"))"
Relation database property objects contain the following configuration within the relation
property. In addition, they must contain a key corresponding with the value of type
. The value is an object containing type-specific configuration. The type-specific configurations are defined below.
database_id
string
(UUID) The database this relation refers to. This database must be shared with the integration. "668d797c-76fa-4934-9b05-ad288df2d136"
type
string
(optional enum) The type of the relation. Can be "single_property"
or "dual_property"
. "single_property"
Single property relation objects have no additional configuration within the single_property
property.
Dual property relation objects have no additional configuration within the dual_property
property.
Rollup database property objects contain the following configuration within the rollup
property:
relation_property_name
optional string
The name of the relation property this property is responsible for rolling up. This relation is in the same database where the new rollup property is being created. One of relation_property_name
or relation_property_id
must be provided. "Meals"
relation_property_id
optional string
The id
of the relation property this property is responsible for rolling up. This relation is in the same database where the new rollup property is being created. One of relation_property_name
or relation_property_id
must be provided. "fy:{"
rollup_property_name
optional string
The name of the property in the related database that is used as an input to function
. The related database must be shared with the integration. One of rollup_property_name
or rollup_property_id
must be provided. "Name"
rollup_property_id
optional string
The id
of the property in the related database that is used as an input to function
. The related database must be shared with the integration. One of rollup_property_name
or rollup_property_id
must be provided. "fy:{"
function
string
(enum) The function that is evaluated for every page in the relation of the rollup.
count_all
, count_values
, count_unique_values
, count_empty
, count_not_empty
, percent_empty
, percent_not_empty
, sum
, average
, median
, min
, max
, range
, show_original
"count"
Created time database property schema objects have no additional configuration within the created_time
property.
Created by database property schema objects have no additional configuration within the created_by
property.
Last edited time database property schema objects have no additional configuration within the last_edited_time
property.
Last edited by database property schema objects have no additional configuration within the last_edited_by
property.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4