LogoLogo
Visit Contextual.ioSign Up
  • Getting Started
    • Welcome
    • Tour: Hello, AI World!
  • TRAINING
    • Basic Developer Training Course
      • Lesson 1: HTTP Agent Introduction
      • Lesson 2: Logging and Error Handling Basics
      • Lesson 3: Event Processing Agent Introduction
  • Services Catalog
    • What's in the Catalog?
      • Intro Patterns
      • Object Type Bundles
    • Browse by Platform
    • All Intro Patterns
      • Anthropic Claude Image Analysis
      • Mistral AI Prompt and Response
      • xAI Grok Prompt and Response
      • DeepSeek Chat Prompt and Response
      • Qwen Chat Prompt and Response
      • Perplexity AI Search and Response
      • Firecrawl Website Scraper
      • Groq Prompt and Response
      • Nyckel Dog Breed Classification
      • RapidAPI ClassifyAI Text Classification
      • RapidAPI YouTube AI Video Summary
      • UnifyAI Model Comparison
      • WebPilot URL Analysis and Summarization
      • OpenAI Assistants Prompt and Response
      • OpenAI Sync
    • All Prebuilt Solutions
      • Invoice AI
      • Lead Generation Form
    • All Object Type Bundles
      • Work Order Management System ITIL Object Type Bundle
        • Work Order
        • User
        • Role
        • Permission
        • Asset
        • Task
        • Action
        • Attachment
        • Comment
        • Notification
        • Audit Log
        • Service Level Agreement
        • Custom Fields
        • Work Order Template
        • Work Order Transition
        • Escalation Policy
        • Tag
  • Components & Data
    • Object Types
      • Data in Contextual
        • Secrets
        • Validation
        • Versioning
      • Examples
      • Creating an Object Type
      • Object Type Details
        • Definition
        • Data Schema
          • Automatic Record Metadata
          • Generated Values
            • Dates and Times
            • UUIDs
          • Frequently Used Validation
          • Disallowing Null Property Values
          • Disallowing Undefined Properties
          • Secrets
          • AI Assistant
          • ID and PrimaryKey Permanence
        • UI Schemas
        • Features
        • Triggers
        • Actions
        • Audit Trail
        • Versions
        • Templates
        • Records
      • Using Object Types in Flows
      • Records
        • Records and Your Tenant API
        • Record Import
    • Flows
      • Nodes
      • Wires
      • Message Object
      • Flow Editor
        • Basics
        • Saving Changes
        • In-Flow Testing with Debugger
        • Restart Agents to Make Changes Active
        • Config
      • Node Reference
        • Common
          • Log Tap
          • Inject
          • Debug
          • Complete
          • Catch
          • Status
          • Link In
          • Link Call
          • Link Out
          • Comment
        • Event
          • Prepare Event
          • Event Start
          • Event End
          • Event Error
        • Object
          • Search Object
          • Get Object
          • Create Object
          • Patch Object
          • Put Object
          • Delete Object
          • Run Action
        • Request
          • Send to Agent
          • HTTP GET
          • HTTP PATCH
          • HTTP PUT
          • HTTP DELETE
          • HTTP POST
          • GQL
          • Produce Message
        • Function
          • Function
          • Switch
          • Change
          • Range
          • Template
          • Delay
          • Trigger
          • Exec
          • Filter
          • Loop
        • Models
          • ML Predict
        • Network
          • MQTT In
          • MQTT Out
          • HTTP In
          • HTTP Response
          • HTTP Request
          • WebSocket In
          • WebSocket Out
          • TCP In
          • TCP Out
          • TCP Request
          • UDP In
          • UDP Out
        • Sequence
          • Split
          • Join
          • Sort
          • Batch
        • Parser
          • csv
          • html
          • json
          • xml
          • yaml
    • Agents
      • Creating an Agent
      • Types of Agents
        • Event to Flow
        • HTTP to Flow
          • Custom Domains
      • How Agents Work
        • Flow Execution
        • HTTP Load Balancing
        • Event Routing
      • Scale and Performance
        • Flow execution
        • Parallel Instances
        • Event Lag Scaling
        • Compute Threshold Scaling
        • Instance Compute Sizing
      • Agent Details
        • Definition
        • Operations
        • Logs
          • Session Log
          • Message Log
        • Audit Trail
        • Versions
      • Using Agents in Flows
    • Connections
      • Creating a Connection
      • Types of Connections
        • Basic
        • Bearer
        • Client Grant
        • Kafka
        • Password Grant
        • Public
        • Pulsar
      • Using Connections in Flows
    • JWKS Profiles
      • Using JWKS Profiles in Your Solution
  • PATTERNS
    • Solution Architecture
      • Events, Messages, Queues
    • Working with Data
      • Search Object Node & Pagination
      • Message Payload Content - Triggers and Actions
    • Industry Cookbooks
      • Field Services
  • Tenants
    • Tenant Workspace
    • Tenant Logs
      • Contextual Log Query Language (CLQL)
        • String Searches
        • Keyword Searches
        • Advanced Operators
    • Tenant API
      • API Keys
        • API Key Settings
        • API Key Permissions
      • Documentation
  • Release Notes
    • 2024
      • 2024.12.09
Powered by GitBook
On this page
  • Introduction
  • What are Object Types?
  • Benefits of Object Types in Contextual
  • Conclusion

Was this helpful?

  1. Components & Data

Object Types

PreviousTagNextData in Contextual

Last updated 1 year ago

Was this helpful?

Introduction

Managing and validating data effectively, and having it immediately available throughout your Contextual solution, is crucial for seamless and performant inter-service communication and data consistency. Contextual's Object Types let you define structured data formats that are automatically validated and processed consistently across every component and interface within your Contextual solution. This article explains the concept of Object Types, the use of JSON schemas for validation, and their role in standardizing the storage, display, and exchange of data in your Contextual solution and enterprise processes.

What are Object Types?

Object Types are structured data definitions that describe the format, types of data, and validation rules for of that Object Type within your Contextual solution. Object Types ensure that data is sent and received in a consistent format, and provide you with a turnkey , full permission controls, audit trail, version control, triggers, actions and more for your data.

Object Types in Contextual include:

  • : Id, Display Name, Description, and Category

  • : a JSON schema that describes the format and primaryKey (permanent) of Records created for the Object Type - importantly, schemas don't need to include properties like createdAt or updatedAt timestamps which are automatically added to Records as

  • : a collection of JSON schemas that describe the UI for the Object Type within the Contextual Workspace UI

  • : manage Audit Trail and Record Versioning, on supported subscription plans

  • : send Records to (and their ) automatically Post-Insert, Post-Update, and Post-Delete for processing

  • : send Records to (and their ) manually in the Contextual Workspace UI, or by executing the Action on a Record using the

  • : as changes are made to the Object Type, a version history is kept - keep track of changes and restore previous versions if needed

  • : define multiple templates with suggested or pre-filled values for Record properties, to aid in rapid and well-informed data entry within the Contextual Workspace UI

  • : one record, or a million - limited only by your Contextual subscription plan

Get started by .

Benefits of Object Types in Contextual

  • Consistency and Predictability: Ensures all parts of your Contextual solution and integrations with other systems adhere to a defined data structure, in programmatic and user-facing interfaces.

  • Documentation: Acts as a self-documenting mechanism for the data in your solution, improving understandability and maintainability.

  • Performance: Internal storage using Contextual Object Types ensures enhanced data security and control, superior performance with low latency operations, and seamless integration.

Conclusion

Contextual Object Types defined with JSON schemas offer a robust method for ensuring data integrity, validation, and consistent data presentation - paired with highly performant, scalable Record storage whether you're storing 1 record or 1 million. They are instrumental in building scalable, reliable, and maintainable solutions by providing clear specifications for data exchange and validation rules. Utilizing Object Types effectively can lead to improved data quality, better interoperability, and a more cohesive developer and user experience across different interfaces.

Validation: Automatic validation of to prevent erroneous or malicious data from affecting the system.

Interoperability: Enables different services to work together seamlessly, understanding the data exchanged without ambiguity using an instant and always up-to-date

Records
Tenant API
Definition
Data Schema
Metadata
UI Schema
Optional Features
Triggers
Agents
Flows
Actions
Agents
Flows
Tenant API
Versions
Templates
Records
Creating an Object Type
incoming data
Tenant API