Skip to content
StoryOS Docs

Create a saved view (config validated against live fields)

POST
/api/v1/workspaces/{ws}/databases/{db}/views

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
db
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 100 characters
type
required
string
Allowed values: table board calendar gallery list feed timeline form dashboard
config
object
filters
Any of:
object
field
required
string
>= 1 characters
op
required
string
Allowed values: eq neq contains not_contains gt gte lt lte before after within has has_none is_empty not_empty
value
disabled
boolean
pinned
boolean
label
string
<= 120 characters
icon
string
<= 40 characters
sorts
Array<object>
default: <= 3 items
object
field
required
string
>= 1 characters
direction
string
default: asc
Allowed values: asc desc
sorts_nulls
string
Allowed values: first last
hidden_field_ids
Array
default:
group_by_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
group_by_granularity
string
Allowed values: week month quarter year
color_by_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
card_field_ids
Array<string>
default:
card_size
string
Allowed values: small medium large
column_sort
string
Allowed values: natural alpha count
hide_empty_groups
boolean
hide_empty_no_value_group
boolean
cover_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
date_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
calendar_mode
string
Allowed values: month week day
calendar_end_date_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
calendar_increment_minutes
Any of:
number
Allowed values: 10
calendar_collapsed_hours
object
start
required
integer
<= 23
end
required
integer
>= 1 <= 24
start_date_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
end_date_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
baseline_start_date_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
baseline_end_date_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
dashboard_tiles
Array<object>
default:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
label
string
"" <= 100 characters
op
required
string
Allowed values: count sum avg min max
field_api_name
string
>= 1 characters <= 100 characters
filter
Any of:
object
field
required
string
>= 1 characters
op
required
string
Allowed values: eq neq contains not_contains gt gte lt lte before after within has has_none is_empty not_empty
value
disabled
boolean
pinned
boolean
label
string
<= 120 characters
icon
string
<= 40 characters
database_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
layout
object
order
required
integer
<= 9007199254740991
w
required
integer
>= 1 <= 12
h
required
integer
>= 1 <= 6
comparison
object
target
number
direction
string
default: up
Allowed values: up down
dashboard_widgets
Array<object>
default:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
type
required
string
Allowed values: bar line pie grouped_table
title
string
"" <= 100 characters
group_by_field_api_name
string
>= 1 characters <= 100 characters
measure
object
op
required
string
Allowed values: count sum avg min max
field_api_name
string
>= 1 characters <= 100 characters
filter
Any of:
object
field
required
string
>= 1 characters
op
required
string
Allowed values: eq neq contains not_contains gt gte lt lte before after within has has_none is_empty not_empty
value
disabled
boolean
pinned
boolean
label
string
<= 120 characters
icon
string
<= 40 characters
database_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
layout
object
order
required
integer
<= 9007199254740991
w
required
integer
>= 1 <= 12
h
required
integer
>= 1 <= 6
summary_widgets
Array<object>
default:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
type
required
string
Allowed values: stat bar line pie
title
string
"" <= 100 characters
op
required
string
Allowed values: count sum avg min max
field_api_name
string
>= 1 characters <= 100 characters
group_by_field_api_name
string
>= 1 characters <= 100 characters
hierarchy_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
form
object
title
string
<= 200 characters
description
string
<= 2000 characters
submit_text
string
<= 50 characters
fields
Array<object>
default:
object
field_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
required
boolean
label
string
<= 100 characters
help
string
<= 500 characters
visible_when
object
field_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
op
required
string
Allowed values: eq neq is_empty not_empty in
value
required_when
object
field_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
op
required
string
Allowed values: eq neq is_empty not_empty in
value
relation_filter
Any of:
object
field
required
string
>= 1 characters
op
required
string
Allowed values: eq neq contains not_contains gt gte lt lte before after within has has_none is_empty not_empty
value
disabled
boolean
pinned
boolean
label
string
<= 120 characters
icon
string
<= 40 characters
hidden
boolean
value
public_token
string
<= 64 characters
access
string
default: members
Allowed values: members link public
success_message
string
<= 500 characters
redirect_url
string format: uri
<= 500 characters
theme
object
accent
string
/^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
surface
string
/^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
text
string
/^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
radius
integer
<= 16
font
string
Allowed values: inter figtree source-sans-3 dm-sans source-serif-4 playfair-display jetbrains-mono
mode
string
Allowed values: light dark
share
object
public_token
string
<= 64 characters
visible_field_api_names
Array<string>
include_relation_api_names
Array<string>
default:
indexable
boolean
recipient_scope_field_api_name
string
column_widths
object
key
additional properties
number
row_height
Any of:
number
Allowed values: 28
folder_id
string format: uuid
nullable /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

201

Section titled “201”