-
Notifications
You must be signed in to change notification settings - Fork 1
Project DTO
tudorgroza edited this page Mar 16, 2021
·
13 revisions
The general form of the DTO is listed below.
On creation:
-
name
is mandatory NOT EMPTY -
datasources
,ontologies
andpreferredMappingOntologies
fields will enable context-level preferences for mappings and will populate thedefault
context of the project. Additional contexts can be added using similar fields via the ContextDTO and the Project contexts endpoints
{
"name": "Project name", // MANDATORY
"description": "Some description",
"numberOfReviewsRequired": 3,
"datasources": [
"atlas",
"uniprot",
"gwas",
...
],
"ontologies": [
"efo",
"mondo",
"hp",
"ordo"
],
"preferredMappingOntologies": [ "efo" ]
}
In responses:
-
id
is NOT EMPTY -
contexts
is a list of ContextDTO objects -
created
follows a standard structure across all DTOs / objects-
timestamp
- always using the format:YYYY-MM-DDThh:mm:ss.ms+TZ
-
user
- always containingname
andemail
-
{
"id": "602392ee1d09a55d6e0384d4",
"name": "Project name",
"description": "Some description",
"numberOfReviewsRequired": 3,
"contexts": [
{
"name": "NAME",
"description": "Some description",
"datasources": [
"atlas",
"uniprot",
"gwas",
...
],
"ontologies": [
"efo",
"mondo",
"hp",
"ordo",
...
],
"preferredMappingOntologies": [ "efo" ]
},
...
],
"created": {
"timestamp": "2021-02-10T16:01:50.131+08:00",
"user": {
"name": "User name",
"email": "User email"
}
}
}