# Study

## Overview

Study data model hosts information about any study.

### Summary

| Field            |                                         Create                                        |                                         Update                                        |                                         Unique                                        |                                        Required                                       |
| ---------------- | :-----------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: |
| id               | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |
| uuid             |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| name             | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| name             | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| creationDate     | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| modificationDate | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| description      | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| size             | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| fqn              | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| notification     | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| groups           | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| files            | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| jobs             | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| individuals      | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| families         | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| samples          | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| cohorts          | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| panels           | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| clinicalAnalyses | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| variableSets     | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| permissionRules  | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| uri              | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| release          | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| sources          | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| type             | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| status           | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| internal         | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| additionalInfo   | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |
| attributes       | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |  ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) |

## Data Model

### Study

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/study/Study.java).

| Field                                                                                                                                                                                                                                                            | Description                                                                                                                                                                                                                 |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><strong>id</strong><br><em>String</em><br></p>                                                                                                                                                                                                                | Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment.                                                                                                                        |
| <p><strong>uuid</strong><br><em>String</em><br></p>                                                                                                                                                                                                              | Unique 32-character identifier assigned automatically by OpenCGA.                                                                                                                                                           |
| <p><strong>name</strong><br><em>String</em><br></p>                                                                                                                                                                                                              | Full Qualified Name (user\@projectId).                                                                                                                                                                                      |
| <p><strong>name</strong><br><em>String</em><br></p>                                                                                                                                                                                                              | Study alias.                                                                                                                                                                                                                |
| <p><strong>creationDate</strong><br><em>String</em><br></p>                                                                                                                                                                                                      | Autogenerated date following the format YYYYMMDDhhmmss containing the date when the entry was first registered.                                                                                                             |
| <p><strong>modificationDate</strong><br><em>String</em><br><br><em>since</em>: 1.0</p>                                                                                                                                                                           | Autogenerated date following the format YYYYMMDDhhmmss containing the date when the entry was last modified.                                                                                                                |
| <p><strong>description</strong><br><em>String</em><br></p>                                                                                                                                                                                                       | Users may provide a description for the entry.                                                                                                                                                                              |
| <p><strong>size</strong><br><em>long</em><br></p>                                                                                                                                                                                                                | Study size.                                                                                                                                                                                                                 |
| <p><strong>fqn</strong><br><em>String</em><br></p>                                                                                                                                                                                                               | Full Qualified Name (user\@projectId).                                                                                                                                                                                      |
| <p><strong>notification</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#studynotification"><em>StudyNotification</em></a><br></p>                                                                                                         | Object represents study notification.                                                                                                                                                                                       |
| <p><strong>groups</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/study#group"><em>Group</em></a><em>></em><br></p>                                                                                                               | A List with related groups.                                                                                                                                                                                                 |
| <p><strong>files</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/file"><em>File</em></a><em>></em><br></p>                                                                                                                        | A List with related files.                                                                                                                                                                                                  |
| <p><strong>jobs</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/job"><em>Job</em></a><em>></em><br></p>                                                                                                                           | A List with related jobs.                                                                                                                                                                                                   |
| <p><strong>individuals</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/individual"><em>Individual</em></a><em>></em><br></p>                                                                                                      | A List with related individuals.                                                                                                                                                                                            |
| <p><strong>families</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/family"><em>Family</em></a><em>></em><br></p>                                                                                                                 | A List with related families.                                                                                                                                                                                               |
| <p><strong>samples</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/sample"><em>Sample</em></a><em>></em><br></p>                                                                                                                  | A List with related samples.                                                                                                                                                                                                |
| <p><strong>cohorts</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/cohort"><em>Cohort</em></a><em>></em><br></p>                                                                                                                  | A List with related cohorts.                                                                                                                                                                                                |
| <p><strong>panels</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/study#panel"><em>Panel</em></a><em>></em><br></p>                                                                                                               | A List with related panels.                                                                                                                                                                                                 |
| <p><strong>clinicalAnalyses</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/clinicalanalysis"><em>ClinicalAnalysis</em></a><em>></em><br></p>                                                                                     | A List with related clinicalAnalyses.                                                                                                                                                                                       |
| <p><strong>variableSets</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/study#variableset"><em>VariableSet</em></a><em>></em><br></p>                                                                                             | A List with related variableSets.                                                                                                                                                                                           |
| <p><strong>permissionRules</strong><br><em>Map<</em><a href="https://docs.opencga.opencb.org/data-models/study#entity"><em>Entity</em></a><em>,Map<</em><a href="https://docs.opencga.opencb.org/data-models/study#entity"><em>Entity</em></a><em>></em><br></p> | <p>A map with related permission rules.<br>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</p> |
| <p><strong>uri</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#uri"><em>URI</em></a><br></p>                                                                                                                                              | Study uri                                                                                                                                                                                                                   |
| <p><strong>release</strong><br><em>int</em><br></p>                                                                                                                                                                                                              | An integer describing the current data release.                                                                                                                                                                             |
| <p><strong>sources</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/study#externalsource"><em>ExternalSource</em></a><em>></em><br></p>                                                                                            | A List with related external sources.                                                                                                                                                                                       |
| <p><strong>type</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#studytype"><em>StudyType</em></a><br></p>                                                                                                                                 | Study type description                                                                                                                                                                                                      |
| <p><strong>status</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#status"><em>Status</em></a><br></p>                                                                                                                                     | Object to set a custom status.                                                                                                                                                                                              |
| <p><strong>internal</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#studyinternal"><em>StudyInternal</em></a><br></p>                                                                                                                     | Internal field for manage the object.                                                                                                                                                                                       |
| <p><strong>additionalInfo</strong><br><em>List<</em><a href="https://docs.opencga.opencb.org/data-models/study#additionalinfo"><em>AdditionalInfo</em></a><em>></em><br></p>                                                                                     | Dictionary that can be customised by users to store any additional information users may require.                                                                                                                           |
| <p><strong>attributes</strong><br><em>Map\<String,Object></em><br></p>                                                                                                                                                                                           | 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](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/panel/Panel.java).

| Field                                                                                                                        | Description                                                                   |
| ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| <p><strong>uuid</strong><br><em>String</em><br></p>                                                                          | Unique 32-character identifier assigned automatically by OpenCGA.             |
| <p><strong>release</strong><br><em>int</em><br></p>                                                                          | An integer describing the current data release.                               |
| <p><strong>version</strong><br><em>int</em><br></p>                                                                          | OpenCGA version of this panel, this is incremented when the panel is updated. |
| <p><del><strong>author</strong></del><br><em>String</em><br><br><em>Deprecated</em></p>                                      | Author of the panel.                                                          |
| <p><strong>status</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#status"><em>Status</em></a><br></p> | Panel status can have the values READY or DELETED.                            |
| <p><strong>studyUid</strong><br><em>long</em><br></p>                                                                        | Panel reference to study.                                                     |
| <p><strong>uid</strong><br><em>long</em><br></p>                                                                             | Panel reference to study.                                                     |

### Group

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/study/Group.java).

### StudyInternal

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/study/StudyInternal.java).

| Field                                                                                                                                        | Description                                           |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| <p><strong>status</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#status"><em>Status</em></a><br></p>                 | Object status.                                        |
| <p><strong>index</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#studyindex"><em>StudyIndex</em></a><br></p>          | Study index.                                          |
| <p><strong>configuration</strong><br><em>StudyConfiguration</em><br></p>                                                                     | Study configuration.                                  |
| <p><strong>status</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#internalstatus"><em>InternalStatus</em></a><br></p> | Status of the internal object.                        |
| <p><strong>registrationDate</strong><br><em>String</em><br></p>                                                                              | Registration date of the internal object.             |
| <p><strong>lastModified</strong><br><em>String</em><br></p>                                                                                  | Date of the last modification of the internal object. |

### StudyNotification

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/study/StudyNotification.java).

| Field                                                                                                                   | Description                    |
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| <p><strong>webhook</strong><br><a href="https://docs.opencga.opencb.org/data-models/study#url"><em>URL</em></a><br></p> | Url of the study notification. |

### PermissionRule

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/study/PermissionRule.java).

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

### Status

You can find the Java code [here](https://github.com/opencb/biodata/tree/develop/biodata-models/src/main/java/org/opencb/biodata/models/common/Status.java).

### Enum Entity

*Enumeration class.* You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/common/Enums/Entity.java).

### AdditionalInfo

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/common/AdditionalInfo.java).

| Field                                                                  | Description                                                                                                                 |
| ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| <p><strong>id</strong><br><em>String</em><br></p>                      | Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment.                        |
| <p><strong>name</strong><br><em>String</em><br></p>                    | Name of the .                                                                                                               |
| <p><strong>description</strong><br><em>String</em><br></p>             | Users may provide a description for the entry.                                                                              |
| <p><strong>type</strong><br><em>String</em><br></p>                    | Type of the additional info.                                                                                                |
| <p><strong>attributes</strong><br><em>Map\<String,Object></em><br></p> | 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](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/common/ExternalSource.java).

| Field                                                      | Description           |
| ---------------------------------------------------------- | --------------------- |
| <p><strong>id</strong><br><em>String</em><br></p>          | Source ID...          |
| <p><strong>name</strong><br><em>String</em><br></p>        | Source name...        |
| <p><strong>description</strong><br><em>String</em><br></p> | Source description... |
| <p><strong>source</strong><br><em>String</em><br></p>      | Source ...            |
| <p><strong>url</strong><br><em>String</em><br></p>         | Source ID             |

### URI

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/java/net/URI.java).

### VariableSet

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/study/VariableSet.java).

### StudyType

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/study/StudyType.java).

| Field                                                      | Description                                                                                          |
| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| <p><strong>id</strong><br><em>String</em><br></p>          | Object ID is a mandatory parameter when creating a new one, this ID cannot be changed at the moment. |
| <p><strong>description</strong><br><em>String</em><br></p> | Users may provide a description for the entry.                                                       |

### StudyIndex

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/study/StudyIndex.java).

### InternalStatus

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/common/InternalStatus.java).

### URL

You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/java/net/URL.java).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.opencga.opencb.org/develop-2/data-models/study.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.