rna_quantification_service.proto

syntax = "proto3";

package ga4gh;

import "ga4gh/rna_quantification.proto";
import "google/api/annotations.proto";

service RnaQuantificationService {
  // 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'.
  rpc SearchRnaQuantificationSets(SearchRnaQuantificationSetsRequest)
    returns (SearchRnaQuantificationSetsResponse) {
      option (google.api.http) = {
        post: "/v0.6.0a10/rnaquantificationsets/search"
        body: "*"
      };
    };


  // Gets a `RnaQuantificationSet` by ID.
  // `GET /rnaquantificationsets/{id}` will return a JSON version of
  // `RnaQuantificationSet`.
  rpc GetRnaQuantificationSet(GetRnaQuantificationSetRequest)
    returns (RnaQuantificationSet) {
      option (google.api.http) = {
        get: "/v0.6.0a10/rnaquantificationsets/{rna_quantification_set_id}"
      };
    };

  // 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'.
  rpc SearchRnaQuantifications(SearchRnaQuantificationsRequest)
    returns (SearchRnaQuantificationsResponse) {
      option (google.api.http) = {
        post: "/v0.6.0a10/rnaquantifications/search"
        body: "*"
      };
    };


  // Gets a `RnaQuantification` by ID.
  // `GET /rnaquantifications/{id}` will return a JSON version of
  // `RnaQuantification`.
  rpc GetRnaQuantification(GetRnaQuantificationRequest)
    returns (RnaQuantification) {
      option (google.api.http) = {
        get: "/v0.6.0a10/rnaquantifications/{rna_quantification_id}"
      };
    };

  // Gets a list of 'ExpressionLevel' matching the search criteria.

  // 'POST /expressionlevels/search' must accept JSON version of
  // 'SearchExpressionLevelsRequest' as the post body and will return a JSON
  // version of 'SearchExpressionLevelsResponse'.
  rpc SearchExpressionLevels(SearchExpressionLevelsRequest)
    returns (SearchExpressionLevelsResponse) {
      option (google.api.http) = {
        post: "/v0.6.0a10/expressionlevels/search"
        body: "*"
      };
    };

// Gets a `ExpressionLevel` by ID.
// `GET /expressionlevels/{id}` will return a JSON version of
// `ExpressionLevel`.
  rpc GetExpressionLevel(GetExpressionLevelRequest)
    returns (ExpressionLevel) {
      option (google.api.http) = {
        get: "/v0.6.0a10/expressionlevels/{expression_level_id}"
      };
    };

}
// ****************  /rnaquantificationsets/search  *******************

// This request maps to the body of 'POST /rnaquantificationsets/search'
// as JSON.
message SearchRnaQuantificationSetsRequest {
  // The `Dataset` to search.
  string dataset_id = 1;

  // Specifies the maximum number of results to return in a single page.
  // If unspecified, a system default will be used.
  int32 page_size = 2;

  // 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.
  string page_token = 3;
}

// This is the response from 'POST /rnaquantificationsets/search' expressed as JSON.
message SearchRnaQuantificationSetsResponse {
  // The list of matching quantification sets.
  repeated RnaQuantificationSet rna_quantification_sets = 1;

  // 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.
  string next_page_token = 2;
}

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

message GetRnaQuantificationSetRequest {
  // The ID of the `RnaQuantificationSet`.
  string rna_quantification_set_id = 1;
}

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

// This request maps to the body of 'POST /rnaquantifications/search'
// as JSON.
message SearchRnaQuantificationsRequest {
  // Return only Rna Quantifications which belong to this set.
  // Must be specified.
  string rna_quantification_set_id = 1;
  
  // Return only RNA quantifications regarding the specified biosample. Optional.
  string biosample_id = 4;

  // Specifies the maximum number of results to return in a single page.
  // If unspecified, a system default will be used.
  int32 page_size = 2;

  // 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.
  string page_token = 3;
}

// This is the response from 'POST /rnaquantifications/search' expressed as JSON.
message SearchRnaQuantificationsResponse {
  // The list of matching quantifications.
  repeated RnaQuantification rna_quantifications = 1;

  // 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.
  string next_page_token = 2;
}

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

message GetRnaQuantificationRequest {
  // The ID of the `RnaQuantification`.
  string rna_quantification_id = 1;
}

// ****************  /expressionlevels/search  *******************
// This request maps to the body of 'POST /expressionlevels/search'
// as JSON.
message SearchExpressionLevelsRequest {
  // The rnaQuantification to restrict search to.
  string rna_quantification_id = 1;

  // Only return expressions with any of the names (strict string matching).
  repeated string names = 6;
  
  // Only return ExpressionLevel records with expressions exceeding
  // this value.  (Defaults to 0.0)
  float threshold = 3;

  // Specifies the maximum number of results to return in a single page.
  // If unspecified, a system default will be used.
  int32 page_size = 4;

  // 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.
  string page_token = 5;
}

// This is the response from 'POST /expressionlevels/search' expressed as JSON.
message SearchExpressionLevelsResponse {
  // The list of matching quantifications.
  repeated ExpressionLevel expression_levels = 1;

  // 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.
  string next_page_token = 2;
}

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

message GetExpressionLevelRequest {
  // The ID of the `ExpressionLevel`.
  string expression_level_id = 1;
}