BEbenchling
RNA Sequence

List NucleotideAlignment items

List NucleotideAlignment items.

get/api/v3/rna-sequence/{rna_sequence_id}/nucleotide-alignments/items

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

rna_sequence_idstring required

ID of the RnaSequence.

Query parameters

createdAt.gtstring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.

createdAt.gtestring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or after the specified time. e.g. >= 2017-04-30.

createdAt.ltstring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30.

createdAt.ltestring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or before the specified time. e.g. <= 2017-04-30.

id.anyOfstring[]

Restricts results to those matching any of the specified IDs. Comma-separated list.

modifiedAt.gtstring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30.

modifiedAt.gtestring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or after the specified time. e.g. >= 2017-04-30.

modifiedAt.ltstring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. < 2017-04-30.

modifiedAt.ltestring datetime

Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or before the specified time. e.g. <= 2017-04-30.

name.anyOfstring[]

Restricts results to those that match any of the specified names. Case insensitive. Warning - this filter can be non-performant due to case insensitivity. Ensure only one name filter is used at a time. Comma-separated list.

name.anyOf.caseSensitivestring[]

Restricts results to those that match any of the specified names. Case sensitive. Ensure only one name filter is used at a time. Comma-separated list.

nextTokenstring

Token for pagination

pageSizeinteger

Number of results to return. Defaults to 50, maximum of 100.

sequenceIds.anyOfstring[]

Restricts results to Nucleotide Alignments owned by any of the specified sequence IDs (i.e. sequences used as the template in a Template Alignment or created as the consensus sequence from a Consensus Alignment). Fails and reports any invalid IDs. Comma-separated list.

sort'createdAt:asc' | 'createdAt:desc' | 'modifiedAt:asc' | 'modifiedAt:desc'

Method by which to order results. Valid sorts are: createdAt (created time, oldest first) and modifiedAt (modified time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.

Response

OK

nextTokenstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.