The Open API specification for Synapse is now available for download!

Download Open API Spec

SearchConfiguration

org.sagebionetworks.repo.model.search.table.SearchConfiguration

A reusable search configuration resource. Bundles synonym sets, column analyzer overrides, and a default analyzer. Bind to any entity in the hierarchy (entity, folder, or project) to define inherited search configuration.

Field Type Description
id STRING The unique ID of this search configuration.
organizationName STRING The name of the Organization this resource belongs to. Immutable after creation.
name STRING The resource name. Must start with a letter and contain only letters, digits, and underscores. Unique within the organization and immutable after creation. Used as part of the qualified name ({organizationName}-{name}) when referenced by other resources.
description STRING Optional description.
synonymSets ARRAY<STRING> Ordered list of SynonymSet qualified names in '{organizationName}-{name}' format to apply. Rules from all sets are unioned.
columnAnalyzerOverrides ARRAY<STRING> Ordered list of ColumnAnalyzerOverride qualified names in '{organizationName}-{name}' format to apply. First-found-wins for duplicate columns.
defaultAnalyzer STRING Default text analyzer for columns without an explicit override, in '{organizationName}-{name}' format.
etag STRING Synapse employs an Optimistic Concurrency Control (OCC) scheme.
createdOn STRING The date this resource was created.
createdBy STRING The ID of the user that created this resource.
modifiedOn STRING The date this resource was last modified.
modifiedBy STRING The ID of the user that last modified this resource.