Skip to main content

​
Terms

  • Blueprint — A collection of sheets that describe a complete dataset
  • Sheet — A collection of fields that describe a single entity (eg. people, products, companies)
  • Field — Describes an attribute of the entity (eg. name, email) and how it should behave
{
  "sheets": [
    {
      "name": "Products",
      "description": "A list of products available for sale",
      "slug": "products",
      "readOnly": false,
      "allowAdditionalFields": false,
      "access": ["add", "edit"],
      "constraints": [{ "name": "constraint name", "fields": ["field_key_one", "field_key_two"], "type": "unique", "strategy": "concat"}],
      "fields": [
        {
          "key": "code",
          "label": "Product Code",
          "description": "This can be **markdown**."
          "type": "string"
        },
        {
          "key": "description",
          "type": "string"
        },
        {
          "key": "price",
          "type": "number"
        }
      ],
      "actions": [],
      "metadata": {},
      "treatments": {'additional'}
    }
  ]
}

Sheet Options

Configure the basic behavior of your Sheet with Sheet-level options.

Field Types

Learn about the different field types and how to use them.

Field Constraints

Learn about the available constraints and how they work.

Field Relationships

Establish connections between Sheets and fields.

Access Control

Configure field, Sheet, and Workbook level user capabilities.

Treatments

Unique presentation for a field in the UI. Learn more about allowAdditionalFields