Study

Overview

Study data model hosts information about any study.

Summary

Field	Create	Update	Unique	Required
id
uuid
name
name
creationDate
modificationDate
description
size
fqn
notification
groups
files
jobs
individuals
families
samples
cohorts
panels
clinicalAnalyses
variableSets
permissionRules
uri
release
sources
type
status
internal
additionalInfo
attributes

Data Model

Study

You can find the Java code here.

Field	Description
id String	Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment.
uuid String	Unique 32-character identifier assigned automatically by OpenCGA.
name String	Full Qualified Name (user@projectId).
name String	Study alias.
creationDate String	Autogenerated date following the format YYYYMMDDhhmmss containing the date when the entry was first registered.
modificationDate String since: 1.0	Autogenerated date following the format YYYYMMDDhhmmss containing the date when the entry was last modified.
description String	Users may provide a description for the entry.
size long	Study size.
fqn String	Full Qualified Name (user@projectId).
notification StudyNotification	Object represents study notification.
groups List<Group>	A List with related groups.
files List<File>	A List with related files.
jobs List<Job>	A List with related jobs.
individuals List<Individual>	A List with related individuals.
families List<Family>	A List with related families.
samples List<Sample>	A List with related samples.
cohorts List<Cohort>	A List with related cohorts.
panels List<Panel>	A List with related panels.
clinicalAnalyses List<ClinicalAnalysis>	A List with related clinicalAnalyses.
variableSets List<VariableSet>	A List with related variableSets.
permissionRules Map<Entity,Map<Entity>	A map with related permission rules. The key of the map can have the values SAMPLES, FILES, COHORTS, INDIVIDUALS, FAMILIES, JOBS, CLINICAL_ANALYSES and DISEASE_PANELS. The value is a List of permission rules
uri URI	Study uri
release int	An integer describing the current data release.
sources List<ExternalSource>	A List with related external sources.
type StudyType	Study type description
status Status	Object to set a custom status.
internal StudyInternal	Internal field for manage the object.
additionalInfo List<AdditionalInfo>	Dictionary that can be customised by users to store any additional information users may require.
attributes Map<String,Object>	You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes.

Panel

You can find the Java code here.

Field	Description
uuid String	Unique 32-character identifier assigned automatically by OpenCGA.
release int	An integer describing the current data release.
version int	OpenCGA version of this panel, this is incremented when the panel is updated.
author String Deprecated	Author of the panel.
status Status	Panel status can have the values READY or DELETED.
studyUid long	Panel reference to study.
uid long	Panel reference to study.

Group

You can find the Java code here.

StudyInternal

You can find the Java code here.

Field	Description
status Status	Object status.
index StudyIndex	Study index.
configuration StudyConfiguration	Study configuration.
status InternalStatus	Status of the internal object.
registrationDate String	Registration date of the internal object.
lastModified String	Date of the last modification of the internal object.

StudyNotification

You can find the Java code here.

Field	Description
webhook URL	Url of the study notification.

PermissionRule

You can find the Java code here.

Field	Description
id String	Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment.
query Query	PermissionRule query.
members List<String>	List of members of the permission rule.
permissions List<String>	List of permissions of the permission rule.

Status

You can find the Java code here.

Enum Entity

Enumeration class. You can find the Java code here.

AdditionalInfo

You can find the Java code here.

Field	Description
id String	Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment.
name String	Name of the .
description String	Users may provide a description for the entry.
type String	Type of the additional info.
attributes Map<String,Object>	You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes.

ExternalSource

You can find the Java code here.

Field	Description
id String	Source ID...
name String	Source name...
description String	Source description...
source String	Source ...
url String	Source ID

URI

You can find the Java code here.

VariableSet

You can find the Java code here.

StudyType

You can find the Java code here.

Field	Description
id String	Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment.
description String	Users may provide a description for the entry.

StudyIndex

You can find the Java code here.

InternalStatus

You can find the Java code here.

URL

You can find the Java code here.