IQSS / IQSS/dataverse

Add API support for downloading the most recent file

Open
#7,425 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: File Upload & Handling Type: Suggestion User Role: API User
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Hi, we have a request for embedding "ambiguous" DV file links into a researcher's static custom website to provide access to the latest version of the file in DV. Every time a file is replaced a new fileID is generated which requires an update to an external website.

This would be adding functionality to the APIs to support retrieving the latest version of a file using the 'rootDataFileId'.

Some examples of this could include:
https://dataverseURL/api/access/datafile/rootDataFileId/?persistentId=doi:../.../&latest=true
https://dataverseURL/api/access/datafile/rootDataFileId/?persistentId=doi:../.../&latest=true&format=original

not sure on the syntax for this, maybe you have some suggestions?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing datafile API entry point for persistentId and checking how rootDataFileId and file versions are handled. Review the proposed latest=true and format=original query forms, then define completion as retrieving the most recent file through a stable rootDataFileId without requiring external file-ID updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.