rna_quantification_service

Gets a list of ‘ExpressionLevel’ matching the search criteria.

This request maps to the URL GET /rnaquantificationsets/{rna_quantification_set_id}.

************ /rnaquantifications/search ***************

This request maps to the URL GET /rnaquantifications/{rna_quantification_id}.

This request maps to the URL GET /expressionlevels/{expression_level_id}.

SearchRnaQuantifications(request)
Parameters:requestSearchRnaQuantificationsRequest
Return type:SearchRnaQuantificationsResponse
Throws:GAException

Gets a list of ‘RnaQuantification’ matching the search criteria. ‘POST /rnaquantifications/search’ must accept JSON version of ‘SearchRnaQuantificationsRequest’ as the post body and will return a JSON version of ‘SearchRnaQuantificationResponse’.

GetExpressionLevel(request)
Parameters:requestGetExpressionLevelRequest
Return type:ExpressionLevel
Throws:GAException

Gets a ExpressionLevel by ID. GET /expressionlevels/{id} will return a JSON version of ExpressionLevel.

GetRnaQuantificationSet(request)
Parameters:requestGetRnaQuantificationSetRequest
Return type:RnaQuantificationSet
Throws:GAException

Gets a RnaQuantificationSet by ID. GET /rnaquantificationsets/{id} will return a JSON version of RnaQuantificationSet.

SearchRnaQuantificationSets(request)
Parameters:requestSearchRnaQuantificationSetsRequest
Return type:SearchRnaQuantificationSetsResponse
Throws:GAException

Gets a list of ‘RnaQuantificationSet’ matching the search criteria. ‘POST /rnaquantificationsets/search’ must accept JSON version of ‘SearchRnaQuantificationSetRequest’ as the post body and will return a JSON version of ‘SearchRnaQuantificationSetResponse’.

SearchExpressionLevels(request)
Parameters:requestSearchExpressionLevelsRequest
Return type:SearchExpressionLevelsResponse
Throws:GAException

‘POST /expressionlevels/search’ must accept JSON version of ‘SearchExpressionLevelsRequest’ as the post body and will return a JSON version of ‘SearchExpressionLevelsResponse’.

GetRnaQuantification(request)
Parameters:requestGetRnaQuantificationRequest
Return type:RnaQuantification
Throws:GAException

Gets a RnaQuantification by ID. GET /rnaquantifications/{id} will return a JSON version of RnaQuantification.

message SearchRnaQuantificationSetsRequest
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 ‘nextPageToken’ from the previous response.

This request maps to the body of ‘POST /rnaquantificationsets/search’ as JSON.

message SearchRnaQuantificationSetsResponse
Fields:
  • rna_quantification_sets (list of RnaQuantificationSet) – The list of matching quantification sets.
  • next_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.

This is the response from ‘POST /rnaquantificationsets/search’ expressed as JSON.

message GetRnaQuantificationSetRequest
Fields:
  • rna_quantification_set_id (string) – The ID of the RnaQuantificationSet.
message SearchRnaQuantificationsRequest
Fields:
  • rna_quantification_set_id (string) – Return only Rna Quantifications which belong to this set. Must be specified.
  • biosample_id (string) – Return only RNA quantifications regarding the specified biosample. Optional.
  • 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.

This request maps to the body of ‘POST /rnaquantifications/search’ as JSON.

message SearchRnaQuantificationsResponse
Fields:
  • rna_quantifications (list of RnaQuantification) – The list of matching quantifications.
  • next_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.

This is the response from ‘POST /rnaquantifications/search’ expressed as JSON.

message GetRnaQuantificationRequest
Fields:
  • rna_quantification_id (string) – The ID of the RnaQuantification.
message SearchExpressionLevelsRequest
Fields:
  • rna_quantification_id (string) – The rnaQuantification to restrict search to.
  • names (string) – Only return expressions with any of the names (strict string matching).
  • threshold (float) – Only return ExpressionLevel records with expressions exceeding this value. (Defaults to 0.0)
  • 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.

************ /expressionlevels/search *************** This request maps to the body of ‘POST /expressionlevels/search’ as JSON.

message SearchExpressionLevelsResponse
Fields:
  • expression_levels (list of ExpressionLevel) – The list of matching quantifications.
  • next_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.

This is the response from ‘POST /expressionlevels/search’ expressed as JSON.

message GetExpressionLevelRequest
Fields:
  • expression_level_id (string) – The ID of the ExpressionLevel.