Type Alias ExportRequest

Request body for exporting semantic types with optional filters.

type ExportRequest = {
    createdBy?: string;
    ids?: string[];
    search?: string;
    types?: ("REGEX" | "DICTIONARY" | "COMPOUND")[];
}
Index
createdBy? ids? search? types?
createdBy?: string

Filter by creator user ID. When provided, only types created by this user are included.

ids?: string[]

List of semantic type IDs to export. When provided, only these types are included.

search?: string

Case-insensitive substring search on label and description fields. Returns only semantic types where the label or description contains the search term. Special regex characters are automatically escaped for literal matching. Maximum length: 500 characters. Empty string returns no results.

types?: ("REGEX" | "DICTIONARY" | "COMPOUND")[]

Filter by semantic type categories. Supports multiple values for OR logic. When provided, only types matching the specified categories are included.

Settings
Member Visibility

On This Page
Properties