BEbenchling
mixtures

List mixtures

List mixtures

get/mixtures

Request

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

Query parameters

nextTokenstring
pageSizeinteger
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 mixture. Restricts results to those with the specified name, alias, or entity registry ID.

nameIncludesstring

Name substring of a mixture. Restricts results to those with names, aliases, or entity registry IDs that include the provided substring.

folderIdstring

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

mentionedInstring

Comma-separated list of entry IDs. Restricts results to mixtures mentioned in those entries.

projectIdstring

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

registryIdstring

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

schemaIdstring

ID of a schema. Restricts results to those of the specified schema.

schemaFieldsSchemaFieldsQueryParam

Filter based on schema field value (not display value). Restricts results to those with a field whose value matches the filter. For Integer, Float, and Date type fields, supports the >= and <= operators (but not < or >). If any schemaField filters are present, the schemaId param must also be present. Note that all operators must be separated from any values by a single space.

archiveReasonstring

Archive reason. Restricts items to those with the specified archive reason. Use "NOT_ARCHIVED" to filter for unarchived mixtures. Use "ANY_ARCHIVED" to filter for archived mixtures regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED" to return items for both archived and unarchived.

mentionsstring

Comma-separated list of resource IDs. Restricts results to those that mention the given items in the description.

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, aliases, or entity registry IDs, 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, aliases, or entity registry IDs, case sensitive.

entityRegistryIds.anyOfstring

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

ingredientComponentEntityIdsstring

Comma-separated list of ingredient component entity ids. Matches all mixtures that contain ingredients whose component entities match all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.

ingredientComponentEntityIds.anyOfstring

Comma-separated list of ingredient component entity ids. Maximum of 100. Matches all mixtures that contain ingredients whose component entities match any of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.

authorIds.anyOfstring

Comma separated list of user or app IDs. Maximum of 100.

Response

OK

nextTokenstring

Changes

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