RecordSet
org.sagebionetworks.repo.model.RecordSet
Captures record-based metadata as a special type of CSV. The record set content can be curated using the grid services.
| Field | Type | Description |
|---|---|---|
| name | STRING | The name of this entity. Must be 256 characters or less. Names may only contain: letters, numbers, spaces, underscores, hyphens, periods, plus signs, apostrophes, and parentheses |
| 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. The value is the fully qualified class name, e.g. 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 |
| isLatestVersion | BOOLEAN | If this is the latest version of the object. |
| dataFileHandleId | STRING | ID of the file associated with this entity. |
| upsertKey | ARRAY<STRING> | One or more column names that define this upsert key for this set. This key is used to determine if a new record should be treated as an update or an insert. |
| csvDescriptor | CsvTableDescriptor | The description of a csv for upload or download. |
| fileNameOverride | STRING | An optional replacement for the name of the uploaded file. This is distinct from the entity name. If omitted the file will retain its original name. |