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

Download Open API Spec

JsonSubColumnModel

org.sagebionetworks.repo.model.table.JsonSubColumnModel

Defines a single sub-column of a column of type JSON. This can be used to enable the faceting of the sub-columns.

Field Type Description
name STRING The display name of the column
columnType ColumnType The column type determines the type of data that can be stored in a column. Switching between types (using a transaction with TableUpdateTransactionRequest in the "changes" list) is generally allowed except for switching to "_LIST" suffixed types. In such cases, a new column must be created and data must be copied over manually
facetType FacetType Set to one of the enumerated values to indicate a column should be treated as a facet
jsonPath STRING Defines the JSON path of the sub column. Use the '$' char to represent the root of JSON object. If the JSON key of a sub column is 'a', then the jsonPath for that column would be: '$.a'.