Docs

Schema Contracts

Generated reference for the Zero platform's JSON Schema contracts — UI presentations, actions, and API entities. 86 contracts.

Api

5

Applicationv1.0

No description provided.

No description provided.

No description provided.

No description provided.

Presentationv1.0

No description provided.

Presentations

64

No description provided.

No description provided.

No description provided.

No description provided.

AutoCompletev1.0

No description provided.

No description provided.

No description provided.

BottomAppBarv1.0

No description provided.

BottomNavigationv1.0

No description provided.

No description provided.

CandlestickChartv1.0

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

ColorPickerv1.0

No description provided.

No description provided.

No description provided.

Configures the DataGrid presentation plugin.

No description provided.

No description provided.

DragAcceptorv1.0

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

GestureListenerv1.0

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

MouseRegionv1.0

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

Presentationv1.0

No description provided.

ProgressIndicatorv1.0

No description provided.

No description provided.

RangeSliderv1.0

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

No description provided.

VideoPlayerv1.0

No description provided.

No description provided.

Actions

17

Generic action envelope executed by DrawerContext.

Displays an alert modal.

ApplyContextv1.0

Deprecated legacy alias for SetContextValue.

zero-schemadeprecated

Opens barcode scanner, capture, or record flows.

Reads and updates drawer context values.

Lets a user pick one or more files.

Makes an HTTP request through the shared HttpService.

Executes one of two actions depending on a condition.

LocalStoragev1.0

Reads and updates local storage values.

Displays a modal containing either a child presentation or a fetched URL.

Navigates to an internal or external URL.

Patches another patchable UI target.

SetContextValuev1.0

Deprecated legacy action for updating context values.

zero-schemadeprecated

SetLocalStorageValuev1.0

Deprecated legacy action for setting local storage values.

zero-schemadeprecated

VisualCapturev1.0

Captures a widget and downloads it as PDF or PNG.

Placeholder websocket action contract.

Sends a message to another subscribed widget or service.

API contracts describe the backend entities of the platform — DataSet, Endpoint, Connection, Application and the Presentation record. These schemas are generated from the C# API models.

Purpose

They document and validate the shape of API resources so clients and tools share one source of truth for what the backend accepts and returns.

Examples

A DataSet definition

{
  "Name": "Orders",
  "DataSetType": "Relational",
  "Columns": [
    { "ColumnName": "Id", "DataType": "CHAR(36)", "PrimaryKey": true }
  ]
}

An Endpoint

{
  "Route": "/reports/daily",
  "EndpointType": "Http",
  "ConnectionId": "…"
}

Presentations are the UI building blocks of a Zero app — declarative components such as Button, Text, Card, Grid and Page. Each is a JSON object with a "PresentationType" and a set of properties.

Purpose

They let a screen be described as data, served from the backend, and rendered into native Flutter widgets at runtime — so the UI can change without shipping a new app build.

Examples

A button that navigates

{
  "PresentationType": "Button",
  "Text": "Save",
  "OnClick": { "Handler": "Navigation", "Route": "/home" }
}

A page with stacked content

{
  "PresentationType": "Column",
  "Children": [
    { "PresentationType": "Text", "Text": "Welcome" },
    { "PresentationType": "Image", "Src": "logo.png" }
  ]
}

Actions are behaviors attached to presentations — the handlers that run on events like OnClick or OnChange. Each is a JSON object with a "Handler" (e.g. Navigation, Http, Modal) and its parameters.

Purpose

They define what happens in response to user interaction — navigating, calling an API, showing a modal, writing storage — as data, so interactivity is configurable without code.

Examples

Navigate to a route

{
  "Handler": "Navigation",
  "Route": "/profile"
}

POST data over HTTP

{
  "Handler": "Http",
  "Url": "/api/data/orders",
  "Method": "POST",
  "Body": { "item": "sku-1" }
}