# Project
## Overview
Created by jacobo on 11/09/14.
### Summary
| Field | create | update | unique | required |
| ---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| id |  |  |  |  |
| name |  |  |  |  |
| fqn |  |  |  |  |
| description |  |  |  |  |
| organism |  |  |  |  |
| currentRelease |  |  |  |  |
| studies |  |  |  |  |
| attributes |  |  |  |  |
| uuid |  |  |  |  |
| creationDate |  |  |  |  |
| modificationDate |  |  |  |  |
| internal |  |  |  |  |
## Data Model
### Project
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/project/Project.java).
| Field | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id
String
| Project ID is a mandatory parameter when creating a new sample, this ID cannot be changed at the moment.*Tags*: *required, immutable, unique* |
| uuid
String
| Global unique ID at the whole OpenCGA installation. This is automatically created during the Project creation and cannot be changed.*Tags*: *internal, unique, immutable* |
| name
String
| |
| fqn
String
| Full Qualified Name (user\@projectId). |
| creationDate
String
| String representing when the sample was created, this is automatically set by OpenCGA.*Tags*: *internal* |
| modificationDate
String
| String representing when was the last time the sample was modified, this is automatically set by OpenCGA.*Tags*: *internal* |
| description
String
| An string to describe the properties of the sample. |
| organism
ProjectOrganism
| |
| currentRelease
int
| |
| studies
List<Study>
| |
| internal
ProjectInternal
| An object describing the internal information of the Project. This is managed by OpenCGA.*Tags*: *internal* |
| attributes
Map<Object,String>
| You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes. |
### Study
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/study/Study.java).
| Field | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id
String
| Study ID is a mandatory parameter when creating a new sample, this ID cannot be changed at the moment.*Tags*: *required, immutable, unique* |
| uuid
String
| Global unique ID at the whole OpenCGA installation. This is automatically created during the study creation and cannot be changed.*Tags*: *internal, unique, immutable* |
| name
String
| |
| alias
String
| |
| creationDate
String
| String representing when the sample was created, this is automatically set by OpenCGA.*Tags*: *internal* |
| modificationDate
String
| String representing when was the last time the sample was modified, this is automatically set by OpenCGA.*Tags*: *internal* |
| description
String
| An string to describe the properties of the sample. |
| size
long
| |
| fqn
String
| |
| notification
StudyNotification
| |
| 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<org.opencb.opencga.core.models.panel.Panel>
| A List with related panels. |
| clinicalAnalyses
List<ClinicalAnalysis>
| A List with related clinicalAnalyses. |
| variableSets
List<VariableSet>
| A List with related variableSets. |
| permissionRules
Map<ListPermissionRule,Enums.Entity>
| |
| uri
URI
| |
| release
int
| |
| status
CustomStatus
| An object describing the status of the Sample. |
| internal
StudyInternal
| An object describing the internal information of the Sample. This is managed by OpenCGA.*Tags*: *internal* |
| attributes
Map<Object,String>
| You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes. |
### ProjectOrganism
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/project/ProjectOrganism.java).
| Field | Description |
| --------------------------------------------------------------- | ----------- |
| scientificName
String
| |
| commonName
String
| |
| assembly
String
| |
### SampleInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/sample/SampleInternal.java).
| Field | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
Status
| |
| rga
RgaIndex
| |
### ProjectInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/project/ProjectInternal.java).
| Field | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| datastores
Datastores
| |
| cellbase
CellBaseConfiguration
| |
| status
Status
| |
### CohortInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/cohort/CohortInternal.java).
| Field | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
CohortStatus
| |
### StudyInternal
You can find the Java code [here](https://github.com/opencb/opencga/blob/master/opencga-core/src/main/java/org/opencb/opencga/core/models/study/StudyInternal.java).
| Field | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| status
Status
| |
| configuration
StudyConfiguration
| |