Skip to content

Create App Page

POST
/app-pages

Create a page over one or more data sources.

Every source is validated against the connector registry BEFORE anything is persisted, so a page can never reference a source that cannot be read. 422 names the offending source rather than failing generically later.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
description
Any of:
string
name
required
string
sources
required

At least one. A page with no data source can never be generated.

Array<object>
>= 1 items

One data source bound into a page. alias is the handle the generated page’s JavaScript addresses it by.

object
alias
Any of:
string
position
integer
role
string
default: data
source_id
required

Opaque to everything but the connector that owns it

string
source_kind
required

Connector family, e.g. staging-table or custom-object

string

Responses

201

Successful Response

object
data
required
object
page_id
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string