Feature #8688
closed
Accept authenticated API calls from data providers to add datasets to a public profile
Description
The API call will have these arguments:
a) a unique identifier for the external data provider
b) the 3rd party activity identifier for the pgp participant which was sent to the data provider when the participant signed up for the activity
c) a payload which indicates what file(s) to import. Details of the format of that payload are TBD, but at a minimum it should probably be a collection of URLs, ideally associated with a file type for each individual file to download. The URLs should include either a manifest file with MD5 digests (like http://cdimage.debian.org/debian-cd/8.3.0/amd64/iso-cd/MD5SUMS), or an *.md5 file for each data file. The size of each file should also be included.
Acceptance criteria¶
When a researcher or admin shows/edits a third party study, the unique identifier for the study is shown. (This is passed as api_key.)
POST /third_party/add_dataset request:
- Ensure
api_keycorresponds to an approved third-party study - Ensure
participant_codeparam corresponds to a participant who is participating in the study (otherwise HTTP 4xx) - Ensure
data_sources_tsvparam is a TSV document, where each line has a URI, size, and hex md5 digest of the corresponding file data - Respond HTTP 4xx if any parameters are invalid or there is an error submitting the download job; otherwise 200
Updated by
Updated by Tom Clegg almost 9 years ago
- Assigned To set to Tom Clegg
- Category set to Third party integration
Updated by Tom Clegg almost 9 years ago
- Description updated (diff)
- Status changed from In Progress to New
Updated by Tom Clegg almost 9 years ago
- Description updated (diff)
- Accepts valid API calls:
POST /third_party/add_datasetwith paramsapi_key,data_sources_tsv,participant_code - Rejects invalid API calls with 4xx and a JSON response body
- Tries to submit an Arvados pipeline using arv-run-pipeline-instance (arvados-cli must be installed, but this dependency can't be in Gemfile because it needs Ruby 1.9.3) (this is part of #8689)
- Introduces a new config knob
ruby19_shell_args(default "rvm-exec 1.9.3")
Updated by Ward Vandewege almost 9 years ago
I looked at 8688-pull-data-api, and I think it's OK to merge. When merged I can deploy to my-dev and we can test functionality. Thanks for adding a journal table!
Updated by Tom Clegg over 8 years ago
- Status changed from In Progress to Resolved