BEbenchling
nucleotideAlignments

List Nucleotide Alignments

List Nucleotide Alignments

get/nucleotide-alignments

Request

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

Query parameters

pageSizeinteger

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

nextTokenstring

Token for pagination

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

Method by which to order search results. Valid sorts are name, modifiedAt, and createdAt. Optionally add :asc or :desc to specify ascending or descending order. Default is modifiedAt.

createdAtstring

Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those created in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

modifiedAtstring

Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

namestring

Name of a Nucleotide Alignment. Restricts results to those with the specified name.

nameIncludesstring

Name substring of a Nucleotide Alignment. Restricts results to those with names that include the provided substring.

idsstring

Comma-separated list of ids. Matches all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.

names.anyOfstring

Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, case insensitive. Warning - this filter can be non-performant due to case insensitivity.

names.anyOf.caseSensitivestring

Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, case sensitive.

sequenceIdsstring

Comma-separated list of sequence ids that own one or more Nucleotide Alignments (i.e. ids of sequences used as the template in a Template Alignment or created as the consensus sequence from a Consensus Alignment). Matches all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.

Response

OK

nextTokenstring

Changes

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