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

Download Open API Spec

TableSchemaChangeRequest

org.sagebionetworks.repo.model.table.TableSchemaChangeRequest

An AsynchronousRequestBody to change the schema of a table.

Field Type Description
concreteType STRING
entityId STRING
changes ARRAY<ColumnChange> List of changes that describes column additions, deletions, and updates
orderedColumnIds ARRAY<STRING> Optional: Used to set the order of columns for this table. If this list is provided it must include the IDs of each column that will be in the schema after the changes of this request are applied.