Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Data

Data objects in Kinesis API represent the actual content stored within your collections. Each data object is associated with a specific collection and contains values for the structures (fields) defined within that collection. This page explains how to create, view, edit, and manage your data.

Understanding Data in Kinesis API

In Kinesis API, data is organized as follows:

  • Projects contain Collections
  • Collections define Structures (fields)
  • Data Objects store values for these structures
  • Each data object contains Data Pairs (structure-value associations)

A data pair links a specific structure (field) with its corresponding value. For example, if you have a "title" structure, a data pair might associate it with the value "My First Article".

🔒 Security Note: All data pairs in Kinesis API are encrypted by design by default. This ensures your data remains secure both at rest and during transmission, providing built-in protection for sensitive information without requiring additional configuration.

Accessing Data Management

To access data management in Kinesis API using the web UI:

  1. Navigate to /web/data in your browser or click "Data" in the main navigation menu
  2. You'll see a list of all projects you have access to
  3. Click on a project to go to /web/data/project?id=project_id and view its collections
  4. Click on a collection to go to /web/data/collection?project_id=project_id&id=collection_id and view its data objects

This hierarchical navigation allows you to drill down from projects to collections to individual data objects.

Data Page

Browsing Projects and Collections

The data management interface follows a logical structure that mirrors your data organization:

Projects Level

At /web/data, you'll see all projects you have access to:

  • Each project is displayed as a card with its name and description
  • You can filter projects using the search box at the top of the page
  • Click on any project to navigate to its collections

Collections Level

At /web/data/project?id=project_id, you'll see all collections within the selected project:

  • Each collection is displayed with its name and description
  • Click on any collection to view its data objects

Viewing Data Objects

From a collection page, you can see all data objects within that collection:

Data Page

Each data object card displays:

  • The object's nickname (if set) or ID
  • Number of structures and custom structures
  • Action buttons for various operations

Data Object Details

To view the details of a data object:

  1. Click the view button (open link icon) or its title on a data object card
  2. You'll be taken to a page displaying all structure values
  3. Regular structures are displayed at the top
  4. Custom structures are displayed below, grouped by their custom structure type

View Data

Creating Data Objects

Users with ROOT, ADMIN, or AUTHOR roles can create new data objects:

  1. From a collection page, click the "Create New" button
  2. Enter an optional nickname for the data object
  3. Fill in values for each structure (field)
  4. For custom structures, fill in values for their component fields
  5. Click "Create" to save the data object

Create Data

Structure Value Types

When creating or editing data objects, different structure types accept different kinds of input:

Structure TypeInput MethodNotes
TEXTText fieldRegular text input
EMAILEmail fieldValidates email format
PASSWORDPassword fieldMasked input with show/hide option
MARKDOWNMarkdown editorWith formatting toolbar
INTEGERNumber inputWhole numbers only
FLOATNumber inputDecimal values allowed
ENUMDropdownSelect from predefined options
DATEDate pickerCalendar interface
DATETIMEDate-time pickerDate and time selection
MEDIAFile uploadUpload images
BOOLEANCheckboxTrue/false toggle
UIDText fieldValid ID
JSONText areaRaw JSON input

Editing Data Objects

Users with ROOT, ADMIN, or AUTHOR roles can edit existing data objects:

  1. From the data object view page, click "Edit Data"
  2. Modify the values for any structures
  3. Click "Update" to save your changes

Edit Data

Deleting Data Objects

Users with ROOT, ADMIN, or AUTHOR roles can delete data objects:

  1. From the data object view or edit page, click "Delete Data"
  2. Confirm the deletion in the modal that appears

⚠️ Warning: Deleting a data object permanently removes it from the system. This action cannot be undone.

User Permissions

Access to data objects is controlled by user roles:

RoleViewCreateEditDelete
ROOT✓✓✓✓
ADMIN✓✓✓✓
AUTHOR✓✓✓✓
VIEWER✓✗✗✗

Additionally, users can only access data within projects they are members of.

Working with Custom Structures

When a collection includes custom structures, data objects for that collection will include sections for each custom structure type:

  1. Each custom structure is displayed in its own card
  2. The card contains fields for all structures within the custom structure
  3. Values are entered and displayed just like regular structures

Custom structures allow for more complex, nested data models within your collections.

Filtering and Pagination

When viewing data objects in a collection:

  1. Use the filter box to search for objects by nickname or ID
  2. Use pagination controls to navigate through large collections
  3. Adjust the page size if needed

Best Practices

For effective data management:

  1. Use Descriptive Nicknames: Give data objects clear, meaningful nicknames to make them easier to identify
  2. Regular Backups: Back up your data regularly, especially before making major changes
  3. Consider Relationships: Design your data structure to reflect relationships between different objects