RNA Sequence

List RnaSequence items

List RnaSequence items.

get/api/v3/rna-sequence/items

Request

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

Query parameters

archiveReason.anyOfstring[]

Restricts items to those with any of the specified archive reasons. Use "NOT_ARCHIVED" to filter for unarchived items. Use "ANY_ARCHIVED" to filter for archived items regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED" to return items for both archived and unarchived. Comma-separated list.

archived.anyOfboolean[]

If true, returns archived items. If false, returns unarchived items. If both true and false, returns archived and unarchived items. Comma-separated list.

authors.anyOfstring[]

Restricts results to those whose author matches any of the specified user or author IDs. Comma-separated list.

bases.anyOfstring[]

Restricts results to those whose sequence exactly matches any of the specified DNA base sequences (case-insensitive, accounting for circular and reverse complement). Comma-separated list.

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.

creator.anyOfstring[]

Restricts results to those created by any of the specified user IDs. Comma-separated list.

entityRegistryIds.anyOfstring[]

Restricts results to those that match any of the specified entity registry IDs. Comma-separated list.

fieldset.anyOfstring[]

Restricts results to those whose schema implements any of the specified fieldset API IDs (custom schema interfaces). Comma-separated list.

folder.eqstring

ID of a folder. Restricts results to its direct children.

id.anyOfstring[]

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

mentionedIn.anyOfstring[]

Restricts results to items mentioned in entries matching any of the specified entry 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

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

pageSizeinteger

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

project.eqstring

ID of a project. Restricts results to those in the project.

registry.eqstring

ID of a registry. Restricts results to those registered in this registry. Specifying "null" returns unregistered items.

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

schema.anyOfstring[]

Restricts results to those that match any of the specified schema IDs. Use only one schema filter arg at a time. Comma-separated list.

schema.eqstring

Single schema ID. Restricts results to those that match the specified schema exactly. Use only one schema filter arg at a time.

systemCategory.anyOfstring[]

Restricts results to those whose schema implements any of the specified system category API IDs (non-exclusive static schema interfaces). 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.