Get samples

get

https://{targetURL}/api/v1/samples

If the archived parameter isn't set, archived=false is automatically implied. To get both archived and non-archived samples you have to make two calls.

Searching for archived samples is not possible. The search parameter is ignored when archived=true.

$expand values (separate with comma for multiple expands):

location
quantity
meta
experiments
parent
children
activeReservation

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

$expand

string

Expand an ID field to an object

$sort

string

Sort by a specific field

$page

string

Set the current page (0 based)

$records

string

Set the number of records to return (1000 maximum)

$viewID

string

Specify a viewID to customize the result

$viewColumns

string

Specify viewColumns to extend the result

sampleTypeID

string

Filter by sampleTypeID

name

string

Filter by sample name

barcodes

string

Filter by barcodes (comma-separated)

archived

string

Filter by archived or non-archived samples. If set to true the search parameter has no effect.

quantityID

string

Filter by quantityID

minimumQuantityAmount

string

Filter for samples that have a minimum quantity amount set

checkedOut

string

Filter for checked out samples

storageID

string

Filter for samples in a storage unit

storageLayerID

string

Filter for samples in a storage layer

seriesID

string

Filter for samples in a series

userID

string

Filter by userID

string

Search term to use for filtering samples. This parameter can't be combined with archived=true.

filterBySampleTypeMetaValues

string

(Optional) JSON array used to filter results. Only exact matches will be returned. This parameter can't be combined with archived=true. Example: [{"sampleTypeMetaID": 1234, "metaValue":"No"}]

filterByMinimumDate

string

(Optional) date in ISO 8601 (YYYY-MM-DDThh:mm:ss) in UTC

filterByMaximumDate

string

(Optional) date in ISO 8601 (YYYY-MM-DDThh:mm:ss) in UTC

Headers

X-Requested-With

string

Defaults to Swagger

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200OK