irida
irida copied to clipboard
Add REST API endpoint for sistr plugin
Describe your idea for a new feature
The build-in SISTR pipeline has a REST API endpoint for accessing results analysis/sistr
, but the plugin version of this pipeline does not have such an endpoint.
Describe how you would access this feature?
External developers would use this endpoint to get access to the plugin SISTR results (useful for scripts used to generate a report of all SISTR results).
Additional information
None.
To add additional information to the request, I would suggest to also add the workflow version (e.g. 0.3.0, 1.1.1b) or workflow_id
to the analysis/sistr
endpoint in case there are multiple analyses associated with a given set of samples and there is a need to extract both or differentiate between them. There could be a scenario that two or more versions of SISTR could be installed on the system either via plugins or built-in version plus a plugin. Thus it is good idea to add plugin version specification.
In addition I discovered that in recent versions of IRIDA probably dating from v21.01 the analysis/sistr
endpoint (containing the link to SISTR analysis results) disappeared even if built-in SISTR (v0.3.0) is not run automatically upon sample upload. I am now using metadata endpoints to extract data from the project which works, but analysis/sistr
endpoint would increase flexibility in case additional data not available in the project metadata endpoint is needed (e.g. sequences, etc.).
E.g. For this recent sample where build-in SISTR v0.3.0 is configured to be run automatically the analysis/sistr
field is present (http://ngs-archive.corefacility.ca/irida/api/samples/193026/pairs/)
But for this sample where SISTR was run manually, it is not present (http://ngs-archive.corefacility.ca/irida/api/samples/190233/pairs)