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

Download Open API Spec

Hit

org.sagebionetworks.repo.model.search.Hit

JSON schema for a Hit in the search results. Each Hit contains a subset of entity data.

Field Type Description
id STRING The unique immutable ID for this entity. A new ID will be generated for new Entities. Once issued, this ID is guaranteed to never change or be re-issued
etag STRING Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time an entity is updated it is used to detect when a client's current representation of an entity is out-of-date.
name STRING The name of this entity
alias STRING The alias of this entity
path EntityPath All entities in this Entity's path
description STRING The description of this entity.
node_type STRING The type of this entity. Corresponds to an (EntityType) value.
created_on INTEGER The seconds since epoch date this entity was created.
modified_on INTEGER The seconds since epoch date this entity was last modified.
created_by STRING The user that created this entity.
modified_by STRING The user that last modified this entity.
diagnosis STRING The result of a medical investigation to identify a disorder from its signs and symptoms.
tissue STRING Type of tissue for the samples in this entity.
consortium STRING The name of the consortium
organ STRING A unique macroscopic (gross) anatomic structure that performs specific functions. It is composed of various tissues. An organ is part of an anatomic system or a body region.