sequence_annotation_service
************* /featuresets ****************
************* /features ************
-
SearchFeatureSets(request)
-
Gets a list of FeatureSet matching the search criteria.
POST /featuresets/search must accept a JSON version of
SearchFeatureSetsRequest as the post body and will return a JSON version
of SearchFeatureSetsResponse.
Gets a FeatureSet by ID.
GET /featuresets/{id} will return a JSON version of FeatureSet.
Gets a Feature by ID.
GET /features/{id} will return a JSON version of Feature.
Gets a list of Feature matching the search criteria.
POST /features/search must accept a JSON version of
SearchFeaturesRequest as the post body and will return a JSON version of
SearchFeaturesResponse.
-
message
SearchFeatureSetsRequest
| 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.
|
|---|
- This request maps to the body of POST /featuresets/search as JSON.
-
message
SearchFeatureSetsResponse
| Fields: |
- feature_sets (list of
FeatureSet) – The list of matching feature 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 /featuresets/search expressed as JSON.
-
message
GetFeatureSetRequest
| Fields: |
- feature_set_id (string) – The ID of the FeatureSet to be retrieved.
|
|---|
This request maps to the URL GET /featuresets/{id}.
-
message
SearchFeaturesRequest
| Fields: |
- feature_set_id (string) – The annotation set to search within. Either feature_set_id or
parent_id must be non-empty.
- name (string) – Only returns features with this name (case-sensitive, exact match).
- gene_symbol (string) – Only return features with matching the provided gene symbol
(case-sensitive, exact match).
This field may be replaced with a more generic representation
in a future version.
- parent_id (string) – Restricts the search to direct children of the given parent feature
ID. Either feature_set_id or parent_id must be non-empty.
- reference_name (string) – Only return features on the reference with this name
(matched to literal reference name as imported from the GFF3).
- start (long) – Required, if name or symbol not provided.
The beginning of the window (0-based, inclusive) for which
overlapping features 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, if name or symbol not provided.
The end of the window (0-based, exclusive) for which overlapping
features should be returned.
- feature_types (string) – TODO: To be replaced with a fully featured ontology search
once the Metadata definitions are rounded out.
If specified, this query matches only annotations whose feature_type
matches one of the provided ontology terms.
- 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.
|
|---|
This request maps to the body of POST /features/search as JSON.
-
message
SearchFeaturesResponse
| Fields: |
- features (list of
Feature) – The list of matching annotations, sorted by start position. Annotations
which share a start position are returned in a deterministic order.
- 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 /features/search expressed as JSON.
-
message
GetFeatureRequest
| Fields: |
- feature_id (string) – The ID of the Feature to be retrieved.
|
|---|
This request maps to the URL GET /features/{id}.