bio_metadata_service

GetIndividual(request)
Parameters:request – GetIndividualRequest
Return type:Individual
Throws:GAException

Gets an Individual by ID. GET /individuals/{id} will return a JSON version of Individual.

SearchBiosamples(request)
Parameters:request – SearchBiosamplesRequest
Return type:SearchBiosamplesResponse
Throws:GAException

POST /biosamples/search must accept a JSON version of SearchBiosamplesRequest as the post body and will return a JSON version of SearchBiosamplesResponse.

GetBiosample(request)
Parameters:request – GetBiosampleRequest
Return type:Biosample
Throws:GAException

Gets a Biosample by ID. GET /biosamples/{id} will return a JSON version of Biosample.

SearchIndividuals(request)
Parameters:request – SearchIndividualsRequest
Return type:SearchIndividualsResponse
Throws:GAException

Gets a list of Individuals accessible through the API. POST /individuals/search must accept a JSON version of SearchIndividualsRequest as the post body and will return a JSON version of SearchIndividualsResponse.

message SearchIndividualsRequest
Fields:
  • dataset_id (string) – Optionally specify the dataset to search within.
  • name (string) – Returns Individuals with the given name found by case-sensitive string matching.
  • page_size (integer) – Specifies the maximum number of results to return in a single page. If unspecified, a system default will be used.
  • page_token (string) – The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

***************** /individuals **************************** This request maps to the body of POST /individuals/search as JSON.

message GetIndividualRequest
Fields:
  • individual_id (string) – The ID of the individual requested

This request maps to the URL GET /individuals/{individual_id}.

message GetBiosampleRequest
Fields:
  • biosample_id (string) – The ID of the biosample requested

This request maps to the URL GET /biosamples/{biosample_id}.

message SearchIndividualsResponse
Fields:
  • individuals (list of Individual) – The list of individuals.
  • next_page_token (string) – The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren’t any additional results.

This is the response from POST /individuals/search expressed as JSON.

message SearchBiosamplesRequest
Fields:
  • dataset_id (string) – Optionally specify the dataset to search within.
  • name (string) – Returns Biosamples with the given name found by case-sensitive string matching.
  • individual_id (string) – Returns Biosamples for the provided individual ID.
  • page_size (integer) – Specifies the maximum number of results to return in a single page. If unspecified, a system default will be used.
  • page_token (string) – The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

***************** /biosamples **************************** This is the request sent to POST /biosamples/search expressed as JSON.

message SearchBiosamplesResponse
Fields:
  • biosamples (list of Biosample) – The list of biosamples.
  • next_page_token (string) – The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren’t any additional results.

This is the response from POST /biosamples/search expressed as JSON.