Skip to content

Request - Add Id search studies/{studyId}/analysis/search/id IdSearch #899

@edsu7

Description

@edsu7

General Request

Add back/improve the endpoint studies/{studyId}/analysis/search/id IdSearch

Background

Previously the endpoint (before donor, sample and specimen Id removal in base song) the endpoint functioned as such:

https://song.rdpc-qa.cumulus.genomeinformatics.org/studies/DATA-CA/analysis/search/id?donorId=DO264796

Returning all analyses related to DO264796

But following the removal of donorId there is now the question of which field to query by.

Possible implementation

Bioinfo has two asks

  1. Add back previous functionally by querying against submitter_analysis_id. For the PCGL data, this field has been found to be consistent and can be reliably queried against.
  2. Make the request dynamic. For the PCGL data model, analysis schemas could reference different submitterIDs and possibly have different fields e.g.
submitter_participant_id submitter_sample_id submitter_specimen_id submitter_experiment_id submitter_analysis_id
analysisTypeA True False False False True
analysisTypeB False True False False True
analysisTypeC False False True False True

In the above table submitter_experiment_id is consistent but submitter_sample_id is not.

If an implementation similar to :

https://submission.pcgl-dev.cumulus.genomeinformatics.org/data/category/1/organization/EXAMPLE-CA9/query

With a suppliable SQON like:

{
  "op": "and",
  "content": [
    {
      "op": "in",
      "content": {
        "fieldName": "submitter_participant_name",
        "value": [
          "Bob"
        ]
      }
    }
  ]
}

Allowing users to dynamically query for analyses

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions