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

Data Access API documentation unclear #3821

Closed
pameyer opened this issue May 5, 2017 · 2 comments
Closed

Data Access API documentation unclear #3821

pameyer opened this issue May 5, 2017 · 2 comments

Comments

@pameyer
Copy link
Contributor

pameyer commented May 5, 2017

http://guides.dataverse.org/en/latest/api/dataaccess.html lists /api/access/datafile/$id (from context, $id refers to database ID of the file (reported by DB queries or api/datasets/:persistentId/ endpoint under files.dataFile.id).

curl -X GET -H "X-Dataverse-key: ${admin_key}" "${dataverse_host}/api/access/datafile/${file_db_identifier}&format=original" returns 404.

Possibly related: #3325 , #2174.

Not currently clear if this is a documentation bug, user error, or API bug.

@pameyer
Copy link
Contributor Author

pameyer commented May 5, 2017

Documentation bug - curl -X GET -H "X-Dataverse-key: ${admin_key}" "${dataverse_host}/api/access/datafile/${file_db_identifier} works (on both published and unpublished data files; and for future reference X-Dataverse-key not needed for published/unrestricted files).

@pameyer pameyer changed the title Data Access API Data Access API documentation unclear May 5, 2017
@pameyer
Copy link
Contributor Author

pameyer commented May 15, 2017

Thanks to clarification from @pdurbin , this was due to incorrect specification of query parameters.

@pameyer pameyer closed this as completed May 15, 2017
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

2 participants