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

Download Open API Spec

ObjectType

org.sagebionetworks.repo.model.ObjectType

JSON enum for the types of objects in Synapse.

Enumeration
name description
ENTITY An element of the file hierarchy, e.g., file project, folder
ENTITY_CONTAINER An entity that can contain other entities
PRINCIPAL A user or group of users
ACTIVITY A provenance element, linking entities to provide their history
EVALUATION An evaluation object, such as a challenge or competition.
EVALUATION_ROUND Rounds defined within a specific Evaluation
SUBMISSION A submission to an evaluation.
EVALUATION_SUBMISSIONS A collection of submissions for an evaluation.
FILE A file object, representing a file stored in Synapse.
MESSAGE A message object, such as a notification or communication.
WIKI A wiki page or documentation object.
FAVORITE A user's favorite entity or object.
ACCESS_REQUIREMENT An access requirement, such as terms of use or data use agreement.
ACCESS_APPROVAL An approval for an access requirement.
TEAM A team object, representing a group of users.
TABLE A table object, representing tabular data.
ACCESS_CONTROL_LIST An access control list (ACL) for managing permissions.
PROJECT_SETTING A project setting or configuration object.
VERIFICATION_SUBMISSION A submission for user or team verification.
CERTIFIED_USER_PASSING_RECORD A record of a user passing the certified user test.
FORUM A discussion forum object.
THREAD A discussion thread in a forum.
REPLY A reply to a thread in a forum.
FORM_GROUP Grouping of form data.
ORGANIZATION User defined schemas are governed by an Organization.
FORM_DATA Data of a form.
ENTITY_VIEW A view of entities, such as a file or project view.
USER_PROFILE Details about a user, like name and organization
DATA_ACCESS_REQUEST A request for access to data.
DATA_ACCESS_SUBMISSION A submission for a data access request.
DATA_ACCESS_SUBMISSION_STATUS The status of a data access submission.
MEMBERSHIP_INVITATION An invitation to join a team
JSON_SCHEMA A JSON schema.
JSON_SCHEMA_DEPENDANT A JSON schema that references other schemas.
DATASET A dataset is a view of a list of entities.
DATASET_COLLECTION A dataset collection is a view of a list of datasets.
THREAD_VIEW Object used to proxy thread views
MATERIALIZED_VIEW A materialized view is defined by SQL run against one or more tables/views
VIRTUAL_TABLE A virtual table is a common table expression that references one or more tables/views
TABLE_STATUS_EVENT A change in the table status
DATA_ACCESS_SUBMISSION_EVENT An event fired when a user submits a data access submission
FILE_EVENT An event fired when a user uploads or downloads the file
QUERY_CACHE_HIT An event fired when a user's query hits the query cache.
PROJECT_STORAGE_EVENT An event fired when project storage change event needs to be propagated.
REPLICATED_EVENT An event fired after an object has been replicated.
PORTAL A representation of a Synapse portal.
OAUTH_CLIENT An OAuth 2.0 Client.
GRID_SESSION A grid session change that triggers index rebuilding.