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

Download Open API Spec

BindSchemaToEntityRequest

org.sagebionetworks.repo.model.entity.BindSchemaToEntityRequest

Request to bind an Entity to a JSON schema.

Field Type Description
entityId STRING The ID of the the entity.
schema$id STRING The $id of the JSON schema to bind to the entity. Note: If the $id includes a semantic version then entity will be bound to that specific version. If the $id excludes the semantic version then the entity will be bound to the latest version of that schema.
enableDerivedAnnotations BOOLEAN When 'true', Synapse will automatically, calculate the derived annotations for the Entities bound to this schema. Defaults to 'false'.