Entity <INTERFACE>

org.sagebionetworks.repo.model.Entity

This is the base interface that all Entities implement.

Known Implementations:
LinkDockerRepositoryFolderVersionableEntityPreviewExampleEntityProject
Field Type Description
concreteType STRING Indicates which implementation of Entity this object represents. It should be set to one of the following: org.sagebionetworks.repo.model.Project, org.sagebionetworks.repo.model.Folder, or org.sagebionetworks.repo.model.FileEntity.
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.
accessControlList STRING This field is deprecated and will be removed in future versions of Synapse
modifiedBy STRING The ID of the user that last modified this entity.
entityType STRING This field is deprecated and will be removed in future versions of Synapse
uri STRING This field is deprecated and will be removed in future versions of Synapse
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
createdOn STRING The date this entity was created.
modifiedOn STRING The date this entity was last modified.
parentId STRING The ID of the Entity that is the parent of this Entity.
createdBy STRING The ID of the user that created this entity.
description STRING The description of this entity.
name STRING The name of this entity.
attachments ARRAY<AttachmentData> This field is deprecated and will be removed in future versions of Synapse
annotations STRING This field is deprecated and will be removed in future versions of Synapse