Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API: Implement individual file downloading through the API #1441

Closed
pdurbin opened this issue Feb 9, 2015 · 2 comments
Closed

API: Implement individual file downloading through the API #1441

pdurbin opened this issue Feb 9, 2015 · 2 comments

Comments

@pdurbin
Copy link
Member

pdurbin commented Feb 9, 2015

In various ways, users have been asking for how individual files can be downloaded via the API. @rliebz opened a Trello card about this and various support tickets have been opened, most recently RT #192990. There's also a thread on the Google Group called "Direct access to data via URL?". @leeper chimed in to express interest in this feature.

This ticket is about downloading individual files via the API.

(There's a related ticket at #183 that's about downloading all the files from a dataset via SWORD, probably as a zip file.)

As far as I understand, downloading individual files has been more or less implemented already but it hasn't yet been documented at http://guides.dataverse.org/en/latest/api , so users are understandably confused. For example, I wanted to expose the URLs for individual files via the Search API in #69 (and did) but I played around with the GUI to try to figure out what the URLs should be to download individual files.

Since @landreev implemented file downloading, I'm going to assign this ticket to him. I'm vaguely aware that the API might support fetching different versions of files (original vs. CSV) and from what I understand API tokens can be used to download restricted files (this is described at #1228 (comment) ). (My little proof-of-concept Dataverse Android app is able to download unrestricted files just fine without a token, as expected.) I believe all that remains is to document the behavior so we can send API users a link to the appropriate section of the API Guide.

@pdurbin pdurbin added this to the In Review - Dataverse 4.0 milestone Feb 9, 2015
@landreev landreev removed the Type: Suggestion an idea label Feb 11, 2015
@landreev landreev modified the milestones: Beta 13 - Dataverse 4.0, In Review - Dataverse 4.0 Feb 11, 2015
@landreev landreev assigned kcondon and unassigned landreev Feb 20, 2015
@landreev
Copy link
Contributor

This was given to me just a documentation task, to add something describing our Data Access API to the guides. I added a section on it to the "API Guide".

@kcondon
Copy link
Contributor

kcondon commented Feb 26, 2015

OK, documentation is present. I believe the basic download singular and bundle functionality was tested in another ticket. The rest of the API needs to be tested but closing this ticket as API documented.

@kcondon kcondon closed this as completed Feb 26, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants