Database attributes

Each database object can contain the following attributes:

{
  "id": uuid,
  "name": "my_store",
  "created_at": datetime,
  "updated_at": datetime,
  "last_generated": datetime,
  "data_url": string,
  "platform": string,
  "variables": {
    "<variable_name>": string
  },
  "entities": entity[]
  "workspace": {
    "id": uuid,
    "name": string
  }
}

id

The UUID of the database

name

The name of the database

created_at

The date and time the database was created.

updated_at

The date and time the database was last updated.

last_generated

The date and time the data was last generated.

data_url

After data is generated, download it from this URL.

platform

The type of the target database.

variables

The default variable values assigned to the database.

entities

List of entities and their attributes. For the list of entity attributes, go to Entity (table) attributes.

workspace

The workspace that the database belongs to. Determined by the workspace name in the request path. You do not provide this when you create or update a database.

Last updated