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

[Spike - API] Analyze the required API extension to support downloading all dataset files #9997

Closed
GPortas opened this issue Oct 11, 2023 · 1 comment
Assignees
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours. User Role: API User Makes use of APIs

Comments

@GPortas
Copy link
Contributor

GPortas commented Oct 11, 2023

Overview of the Feature Request

Analyze #9996 to better understand the scope of the required development and create development spike issues.

What kind of user is the feature intended for?
API User

What inspired the request?

What existing behavior do you want changed?

  • N/A

Any brand new behavior do you want to add to Dataverse?

  • N/A

Any open or closed issues related to this feature request?

@GPortas GPortas added User Role: API User Makes use of APIs Size: 10 A percentage of a sprint. 7 hours. pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows labels Oct 11, 2023
@GPortas GPortas moved this to Re-arch: SPA MVP (Guillermo) in IQSS Dataverse Project Oct 11, 2023
@GPortas GPortas changed the title [Spike - API] Analyze the required API extension to support Dataset Download Options [Spike - API] Analyze the required API extension to support dataset files download options Oct 11, 2023
@GPortas GPortas changed the title [Spike - API] Analyze the required API extension to support dataset files download options [Spike - API] Analyze the required API extension to support downloading all dataset files Oct 11, 2023
@GPortas GPortas moved this from Re-arch: SPA MVP (Guillermo) to SPRINT READY in IQSS Dataverse Project Nov 27, 2023
@GPortas GPortas moved this from SPRINT READY to Clear of the Backlog in IQSS Dataverse Project Nov 27, 2023
@GPortas GPortas self-assigned this Nov 28, 2023
@GPortas
Copy link
Contributor Author

GPortas commented Nov 29, 2023

After analysis, no API extension is required.

For multiple file download, we can use the existing /access/datafiles endpoint: API Guide. This endpoint provides the option to download original or archival files.

For downloading all dataset files, we can use the existing /access/dataset/{id}/versions/{versionId}endpoint: API Guide. It is very similar to the previous one described, and also provides the option to download original or archival files.

The SPA can call the access API directly as it already does in other scenarios.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours. User Role: API User Makes use of APIs
Projects
Status: No status
Development

No branches or pull requests

1 participant