variant_service

SearchVariants(request)
Parameters:requestSearchVariantsRequest
Return type:SearchVariantsResponse
Throws:GAException

Gets a list of Variant matching the search criteria.

POST /variants/search must accept a JSON version of SearchVariantsRequest as the post body and will return a JSON version of SearchVariantsResponse.

GetCallSet(request)
Parameters:requestGetCallSetRequest
Return type:CallSet
Throws:GAException

Gets a CallSet by ID.

GET /callsets/{id} will return a JSON version of CallSet.

SearchVariantSets(request)
Parameters:requestSearchVariantSetsRequest
Return type:SearchVariantSetsResponse
Throws:GAException

Gets a list of VariantSet matching the search criteria.

POST /variantsets/search must accept a JSON version of SearchVariantSetsRequest as the post body and will return a JSON version of SearchVariantSetsResponse.

GetVariantSet(request)
Parameters:requestGetVariantSetRequest
Return type:VariantSet
Throws:GAException

Gets a VariantSet by ID.

GET /variantsets/{variant_set_id} will return a JSON version of VariantSet.

GetVariant(request)
Parameters:requestGetVariantRequest
Return type:Variant
Throws:GAException

Gets a Variant by ID.

GET /variants/{id} will return a JSON version of Variant.

SearchCallSets(request)
Parameters:requestSearchCallSetsRequest
Return type:SearchCallSetsResponse
Throws:GAException

Gets a list of call sets matching the search criteria.

POST /callsets/search must accept a JSON version of SearchCallSetsRequest as the post body and will return a JSON version of SearchCallSetsResponse.

message SearchVariantSetsRequest
Fields:
  • dataset_id (string) – The Dataset to search.
  • 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 next_page_token from the previous response.

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

message SearchVariantSetsResponse
Fields:
  • variant_sets (list of VariantSet) – The list of matching variant sets.
  • 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 /variantsets/search expressed as JSON.

message GetVariantSetRequest
Fields:
  • variant_set_id (string) – The ID of the VariantSet to be retrieved.

This request maps to the URL GET /variantsets/{id}.

message SearchVariantsRequest
Fields:
  • variant_set_id (string) – The VariantSet to search.
  • call_set_ids (string) – Only return variant calls which belong to call sets with these IDs. If unspecified, return all variants and no variant call objects.
  • reference_name (string) – Required. Only return variants on this reference.
  • start (long) – Required. The beginning of the window (0-based, inclusive) for which overlapping variants should be returned. Genomic positions are non-negative integers less than reference length. Requests spanning the join of circular genomes are represented as two requests one on each side of the join (position 0).
  • end (long) – Required. The end of the window (0-based, exclusive) for which overlapping variants should be returned.
  • 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 next_page_token from the previous response.

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

message SearchVariantsResponse
Fields:
  • variants (list of Variant) – The list of matching variants. If the callSetId field on the returned calls is not present, the ordering of the call sets from a SearchCallSetsRequest over the parent VariantSet is guaranteed to match the ordering of the calls on each Variant. The number of results will also be the same.
  • 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 /variants/search expressed as JSON.

message GetVariantRequest
Fields:
  • variant_id (string) – The ID of the Variant to be retrieved.

This request maps to the URL GET /variants/{id}.

message SearchCallSetsRequest
Fields:
  • variant_set_id (string) – The VariantSet to search.
  • name (string) – Only return call sets with this name (case-sensitive, exact match).
  • biosample_id (string) – Return only call sets generated from the provided Biosample 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 next_page_token from the previous response.

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

message SearchCallSetsResponse
Fields:
  • call_sets (list of CallSet) – The list of matching call sets.
  • 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 /callsets/search expressed as JSON.

message GetCallSetRequest
Fields:
  • call_set_id (string) – The ID of the CallSet to be retrieved.

This request maps to the URL GET /callsets/{call_set_id}.