search

virusseq / portal-ui

Canadian VirusSeq Data Portal
https://virusseq-dataportal.ca/
GNU Affero General Public License v3.0
8 stars 8 forks source link

REST api or similar to acquire data #160

Open scottcain opened 2 years ago

scottcain commented 2 years ago

I think I asked about this in Slack but probably at the wrong time of day :-) so I'm making an issue so I don't forget about it:

Is there a REST endpoint or the like that users can use to get the most recent data?

b-f-chan commented 2 years ago

This is part of the new work packages, we will need to spec out and implement

joneubank commented 2 years ago

All data available in the search is available through a GraphQL endpoint provided by arranger. Perhaps what is needed is a short document to be written to explain how to interact with this API since not everyone is familiar with GQL and the filter objects (SQON) used to query it are a syntax unique to Arranger.

PLACEHOLDER: will put the URL to the API here once I get the URL after the maintenance window closes.

justincorrigible commented 2 years ago

@joneubank the URL (for prod) is ~https://arranger.virusseq-dataportal.ca/<<"project">>/graphql, where the current "project" is cancogen_sep23.~ https://arranger.virusseq-dataportal.ca/graphql after the Arranger3 update. (Edit: June 16 2023)

ghost commented 2 years ago

We need more details on this request.

  1. Who are the end users for this REST endpoint
  2. What kind of data are we looking for here?
  3. What are the potential use cases for this?