Namespace Reference
Pages and sites
Curated JQL namespaces and examples for pages and sites.
Sites namespaces back the Page Builder, widgets, page history, prompt history, page widgets, public pages, portal pages, and tab views.
Key namespaces and models
sites.Widgetsites.Pagesites.PageHistorysites.PagePromptHistorysites.PageWidgetsites.PageTabViewsettings.Preferencesettings.UserMenu
Common controller intents
sites.Page.listPageIconssites.Page.irisGeneratePagesites.Page.irisUpdatePagesites.Page.irisStreamGeneratesites.Page.retrievePublicPagesites.Page.retrieveSitePagesites.Page.retrieveAdminPagesettings.Preference.togglePageTabsettings.Preference.rearrangePageTabs
Common model intents
Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.
Retrieve example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "sites.Page",
5 "intent": "retrieve",
6 "authenticationClass": "jwt",
7 "ordering": "-created",
8 "limit": 20
9 },
10 "id": null,
11 "created": null
12}Create example
json
1{
2 "__meta__": {
3 "schema": "model",
4 "namespace": "sites.Page",
5 "intent": "create",
6 "authenticationClass": "jwt",
7 "return": {
8 "id": null,
9 "name": null,
10 "alias": null
11 }
12 },
13 "name": "Operations dashboard",
14 "alias": "operations-dashboard",
15 "audience": "staff"
16}For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.