List all DRS objects related to a biosample.

POST

/biosamples

curl --request POST \
  --url https://your-candig-domain/drs/ga4gh/drs/v1/biosamples \
  --header 'Content-Type: application/json' \
  --data '{ "program_ids": [ "example" ], "submitter_sample_ids": [ "example" ] }'

List all DRS objects matching an array of submitter_sample_ids. Only authorized for site admins and authzed services.

Authorizations

• None
• BasicAuth
• BearerAuth

Parameters

Query Parameters

verified_only

boolean

Only return analyses with verified files

Request Body

List of submitter sample ids requested

Media typeapplication/json

object

program_ids

Array<string>

submitter_sample_ids

Array<string>

Example^generated

{
  "program_ids": [
    "example"
  ],
  "submitter_sample_ids": [
    "example"
  ]
}

Responses

200

The DrsObjects were found successfully

Media typeapplication/json

Array

Any of:

object

object

biosample_id

MoH submitter_sample_id from a Sample Registration associated with a specimen.

string

program

MoH program ID

string

experiments

Arrays of associated experiment IDs derived from the biosample, keyed by type.

object

wgs

Array<string>

wts

Array<string>

runs

An array of associated run IDs that describe raw reads derived from biosample.

Array<string>

analyses

Arrays of associated analysis IDs based on the biosample, keyed by analysis type.

object

reference_alignment

Array<string>

sequence_variation

Array<string>

sequence_annotation

Array<string>

Example^generated

[
  {
    "biosample_id": "example",
    "program": "example",
    "experiments": {
      "wgs": [
        "example"
      ],
      "wts": [
        "example"
      ]
    },
    "runs": [
      "example"
    ],
    "analyses": {
      "reference_alignment": [
        "example"
      ],
      "sequence_variation": [
        "example"
      ],
      "sequence_annotation": [
        "example"
      ]
    }
  }
]