Get Release Notes
get_release_notesRetrieve ImmPort data release notes, release histories, and study release status to see which releases exist, what each contains, and when or why a study was released or updated.
Instructions
ImmPort data releases and the release history of studies. Data releases are named DR (e.g. DR69, DR58, point releases like DR52.1); version also accepts 58 or dr58. Requires authentication.
Modes (chosen by which arguments are given): • study_accession only → each study's release history, newest first: [{studyAccession, briefTitle, releases: [{version, releaseDate, status, releaseNotes}]}]. status is 'Initial' (first released) or 'Updated'. releaseNotes is often null for older releases. study_accession may list up to 20 studies separated by commas. • study_accession + version='DR58' → only that release's entry for each study (404 if the study was not in that release). • study_accession + version='latest' → each study's OWN most recent release (e.g. SDY1 → DR58, even if the current release is DR69). • version only (e.g. 'DR69', or 'latest' for the newest release) → the release notes document the data release process published for that release, as is: release_version, release_date, study.studies[] (study_accession, brief_title, description, status, subjects, personnel, publications, assays, programs, release_notes on recent releases) and dataSummary (totals at that release). ⚠️ Large: 100–700 KB. 404 if its notes are not published yet. • neither → list of all data releases, newest first: [{version, releaseDate, initialStudyCount, updatedStudyCount}].
Examples: get_release_notes() # which releases exist get_release_notes(version='latest') # what's in the newest release get_release_notes(study_accession='SDY1') # when was SDY1 released/updated, and why get_release_notes(study_accession='SDY1,SDY269', version='latest')
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | ||
| study_accession | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |