EntityView

org.sagebionetworks.repo.model.table.EntityView

A view of Entities within a defined scope.

Field Type Description
name STRING The name of this entity. Must be 256 characters or less.
description STRING The description of this entity. Must be 1000 characters or less.
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.
createdOn STRING The date this entity was created.
modifiedOn STRING The date this entity was last modified.
createdBy STRING The ID of the user that created this entity.
modifiedBy STRING The ID of the user that last modified this entity.
parentId STRING The ID of the Entity that is the parent of this Entity.
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.
versionNumber INTEGER The version number issued to this version on the object.
versionLabel STRING The version label for this entity
versionComment STRING The version comment for this entity
columnIds ARRAY<STRING> The list of ColumnModel IDs that define the schema for this table.
scopeIds ARRAY<STRING> The list of container ids that define the scope of this view.
viewTypeMask INTEGER Bit mask representing the types to include in the view. The following are the possible types (type=): File=0x01, Project=0x02, Table=0x04, Folder=0x08, View=0x10, Docker=0x20.
type ViewType Deprecated. Use: 'viewTypeMask'