Overview

Provides a simplified type reference for creating or editing records in the specified domain. This endpoint returns a sample input structure showing which fields are required and their expected data types, making it easier for developers to construct valid POST/PUT requests without consulting full schema documentation.

What it returns:

A lightweight "input template" that shows:

• InputSample - A dictionary of field names mapped to their .NET type names (as strings)
• FieldsByMajorCoverage - Coverage-specific field groupings (for domains with coverage relationships)

This differs from /DataDictionary (comprehensive schema) and /ScreenConfiguration (UI layout) by providing just the essentials needed to construct input payloads for insert/update operations.

Use Cases

• Quick API Integration - Discover required fields without diving into full data dictionary
• Payload Construction - Generate sample JSON for testing insert/update endpoints
• Type Validation - Verify expected data types before making API calls
• Dynamic Form Generation - Build minimal input forms with correct field types
• Documentation/Testing - Auto-generate API request examples
• Protoyping - Rapidly generate minimal valid test data