Required BrAPI Endpoints ======================== - GET /trials - GET /studies - GET /locations - GET /germplasm - GET /observationunits - GET /events - GET /samples - GET /variables MIAPPE to BrAPI =============== +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | MIAPPE | MIAPPE | BrAPI | BrAPI Field | Notes | | | | | | | | ID | Field | Entity | | | +========+=============================================+======================+============================================================+===============================================+ | DM-1 | Investigation | Trial | -- | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-2 | Investigation unique ID | Trial | trial .trialDbId | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-3 | Investigation title | Trial | trial .trialName | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-4 | Investigation description | Trial | trial .trialDescription | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-5 | Submission date | Trial | trial .datasetAuthorships[] .submissionDate | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-6 | Public release date | Trial | trial .datasetAuthorships[] .publicReleaseDate | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-7 | License | Trial | trial .datasetAuthorships[] .license | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-8 | MIAPPE version | -- | -- | MIAPPE version is not applicable in BrAPI . | | | | | | Use the 'additionalInfo' field if necessary | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-9 | Associated publication | Trial | trial .publications[] | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-10 | Study | Study | -- | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-11 | Study unique ID | Study | study .studyDbId | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-12 | Study title | Study | study .studyName | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-13 | Study description | Study | study .studyDescription | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-14 | Start date of study | Study | study .startDate | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-15 | End date of study | Study | study .endDate | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-16 | Contact institution | Location | location .instituteName | | | | | | | | | | | | location .instituteAddress | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-17 | Geographic location (country) | Location | location .countryCode | | | | | | | | | | | | location .countryName | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-18 | Experimental site name | Location | location .locationName | | | | | | | | | | | Study | study .locationName | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-19 | Geographic location (latitude) | Location | location .coordinates | GeoJSON Structure | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-20 | Geographic location (longitude) | Location | location .coordinates | GeoJSON Structure | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-21 | Geographic location (altitude) | Location | location .coordinates | GeoJSON Structure | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-22 | Description of the experimental | Study | study .experimentalDesign .description | | | | design | | | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-23 | Type of experimental design | Study | study .experimentalDesign .PUI | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-24 | Observation unit level hierarchy | Study | study .observationLevels | Also available with 'GET /observationLevels' | | | | | | endpoint | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-25 | Observation unit description | Study | study .observationUnitsDescription | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-26 | Description of growth facility | Study | study .growthFacility .description | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-27 | Type of growth facility | Study | study .growthFacility .PUI | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-28 | Cultural practices | Study | study .culturalPractices | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-29 | Map of experimental design | -- | -- | There is no direct mapping for MIAPPE DM-29 . | | | | | | Alternative options: | | | | | | | | | | | | A) Use study .additionalInfo to include a | | | | | | file URL | | | | | | | | | | | | B) Use 'GET /observationunits?studyDbId=XYZ' | | | | | | to retrieve the field layout information for | | | | | | a study | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-30 | Person | Contact | -- | The 'contacts' array is embedded in both | | | | | | the Trial and Study entities | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-31 | Person name | Trial | trial .contacts[] .name | | | | | | | | | | | Study | study .contacts[] .name | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-32 | Person email | Trial | trial .contacts[] .email | | | | | | | | | | | Study | study .contacts[] .email | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-33 | Person ID | Trial | trial .contacts[] .contactDbId | | | | | | | | | | | Study | trial .contacts[] .orcid | | | | | | | | | | | | study .contacts[] .contactDbId | | | | | | | | | | | | study .contacts[] .orcid | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-34 | Person role | Trial | trial .contacts[] .type | | | | | | | | | | | Study | study .contacts[] .type | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-35 | Person affiliation | Trial | trial .contacts[] .instituteName | | | | | | | | | | | Study | study .contacts[] .instituteName | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-36 | Data File | Study | study .dataLinks[] | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-37 | Data file link | Study | study .dataLinks[] .url | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-38 | Data file description | Study | study .dataLinks[] .name | | | | | | | | | | | | study .dataLinks[] .description | | | | | | | | | | | | study .dataLinks[] .dataFormat | | | | | | | | | | | | study .dataLinks[] .fileFormat | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-39 | Data file version | Study | study .dataLinks[] .version | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-40 | Biological Material | Germplasm | -- | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-41 | Biological | Germplasm | germplasm .germplasmDbId | | | | | | | | | | | | germplasm .germplasmPUI | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-42 | Organism | Germplasm | germplasm .taxonIds[] | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-43 | Genus | Germplasm | germplasm .genus | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-44 | Species | Germplasm | germplasm .species | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-44' | Infra-specific name | Germplasm | germplasm .subtaxa | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-45 | Biological material latitude | -- | -- | There is no direct mapping for MIAPPE DM-45 . | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-46 | Biological material longitude | -- | -- | There is no direct mapping for MIAPPE DM-46 . | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-47 | Biological material altitude | -- | -- | There is no direct mapping for MIAPPE DM-47 . | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-48 | Biological material coordinates uncertainty | -- | -- | There is no direct mapping for MIAPPE DM-48 . | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-49 | Biological material preprocessing | Germplasm | germplasm .germplasmPreprocessing | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-50 | Material source ID | Germplasm | germplasm .donors[] .donorInstituteCode | | | | | | | | | | | | germplasm .donors[] .donorAccessionNumber | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-51 | Material source DOI | Germplasm | germplasm .donors[] .germplasmPUI | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-52 | Material source latitude | Germplasm | germplasm .germplasmOrigin .coordinates | GeoJSON structure | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-53 | Material source longitude | Germplasm | germplasm .germplasmOrigin .coordinates | GeoJSON structure | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-54 | Material source altitude | Germplasm | germplasm .germplasmOrigin .coordinates | GeoJSON structure | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-55 | Material source coordinates uncertainty | Germplasm | germplasm .germplasmOrigin .coordinateUncertainty | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-56 | Material source description | Germplasm | germplasm .seedSourceDescription | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-57 | Environment | Study | study .environmentParameters[] | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-58 | Environment parameter | Study | study .environmentParameters[] .parameterName | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-59 | Environment parameter value | Study | study .environmentParameters[] .value | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-60 | Experimental Factor | Observation Unit | observationUnit .treatments[] | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-61 | Experimental Factor type | Observation Unit | observationUnit .treatments[] .factor | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-62 | Experimental Factor description | Observation Unit | observationUnit .treatments[] .modality | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-63 | Experimental Factor values | Observation Unit | observationUnit .treatments[] .modality | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-64 | Event | Event | -- | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-65 | Event type | Event | event .eventType | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-66 | Event accession number | Event | event .eventTypeDbId | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-67 | Event description | Event | event .eventDescription | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-68 | Event date | Event | event .date | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-69 | Observation Unit | Observation Unit | -- | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-70 | Observation unit ID | Observation Unit | observationUnit .observationUnitDbId | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-71 | Observation unit type | Observation Unit | observationUnit .observationUnitPosition .observationLevel | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-72 | External ID | Observation Unit | observationUnit .observationUnitPUI | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-73 | Spatial distribution | Observation Unit | observationUnit .observationUnitPosition | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-74 | Observation Unit factor value | Observation Unit | observationUnit .treatments[] | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-75 | Sample | Sample | -- | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-76 | Sample ID | Sample | sample .sampleDbId | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-77 | Plant structure development stage | Sample | sample .tissueType | | | | | | | | | | | | sample .sampleDescription | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-78 | Plant anatomical entity | Sample | sample .tissueType | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-79 | Sample description | Sample | sample .sampleDescription | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-80 | Collection date | Sample | sample .sampleTimestamp | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-81 | External ID | Sample | sample .samplePUI | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-82 | Observed Variable | Observation Variable | -- | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-83 | Variable ID | Observation Variable | observationVariable .observationVariableDbId | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-84 | Variable name | Observation Variable | observationVariable .observationVariableName | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-85 | Variable accession number | Observation Variable | observationVariable .ontologyReference | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-86 | Trait | Observation Variable | observationVariable .trait .traitName | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-87 | Trait accession number | Observation Variable | observationVariable .trait .ontologyReference | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-88 | Method | Observation Variable | observationVariable .method .name | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-89 | Method accession number | Observation Variable | observationVariable .method .ontologyReference | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-90 | Method description | Observation Variable | observationVariable .method .description | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-91 | Reference associated to the method | Observation Variable | observationVariable .method .bibliographicalReference | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-92 | Scale | Observation Variable | observationVariable .scale .scaleName | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-93 | Scale accession number | Observation Variable | observationVariable .scale .ontologyReference | | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+ | DM-94 | Time scale | -- | -- | There is no direct mapping for MIAPPE DM-94 . | +--------+---------------------------------------------+----------------------+------------------------------------------------------------+-----------------------------------------------+