Skip to main content
The schema API exposes the structure of CDF resource types that transformations can write to. You can retrieve the schema for instances, sequence rows, or any other supported resource type. This helps you build valid SQL queries that match the expected destination structure.

​
What the schema API does

The schema API returns the column names, data types, and constraints for each CDF resource type that transformations support. Use this information to construct SQL statements that align with the destination schema and avoid runtime errors from mismatched columns or types.

​
When to use it

  • Building transformations: Reference the schema when writing SELECT statements that target a specific resource type.
  • Validation: Ensure your query output columns match the destination schema before running transformations.
  • Documentation: Inspect available fields and types for instances, sequence rows, or other resources.
Schema structure may vary by resource type. Always retrieve the schema for your target resource before defining transformation output.

​
Supported resources

The schema API supports resource types such as instances from data models, sequence rows, time series, events, and assets. Each resource type has its own schema definition that specifies the required and optional fields.
Last modified on April 23, 2026