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

Download Open API Spec

SynonymSet

org.sagebionetworks.repo.model.search.table.SynonymSet

A shared set of synonym rules. SynonymSets belong to an Organization and can be referenced by SearchConfigurations. Cannot be deleted while referenced by any SearchConfiguration.

Field Type Description
id STRING The unique ID of this synonym set.
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 of the synonym set.
rules ARRAY<SynonymRule> The list of synonym rules in this set.
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.