Skip to navigation

Retrieve a reserved sample

Beta
Retrieves the details of an existing reserved sample by its unique identifier.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

studyIdstringRequiredformat: "^sdy_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study.
reservedSampleIdstringRequiredformat: "^rsp_[a-zA-Z0-9]{10,22}$"
The unique identifier of the reserved sample.

Headers

X-Studies-Api-VersionstringOptional

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The requested reserved sample.
idstringformat: "^rsp_[a-zA-Z0-9]{10,22}$"
Unique identifier for a reserved sample, a sample name reserved by the sampling plan before the sample is planned or collected.
namestring
The reserved sample name.
statusenum

The lifecycle status of a reserved sample name. reserved: the name is reserved and waiting to be assigned to a planned or collected sample. planned: the reserved sample has been assigned to a planned sample. collected: the reserved sample has been used by a collected sample. cancelled: the reserved sample’s associated sample was cancelled after being planned or collected.

Allowed values:
sample_definition_idstringformat: "^sdf_[a-zA-Z0-9]{10,22}$"
Unique identifier for a sample definition, the template a planned sample was created from.
planned_animal_idstring or nullformat: "^adf_[a-zA-Z0-9]{10,22}$"

The planned animal (animal definition) this reserved sample is assigned to. At least one of planned_animal_id or animal_id will be non-null.

animal_idstring or nullformat: "^aml_[a-zA-Z0-9]{10,22}$"

The registered animal this reserved sample was collected for. At least one of animal_id or planned_animal_id will be non-null.

study_group_idstring or nullformat: "^grp_[a-zA-Z0-9]{10,22}$"
The study group this reserved sample belongs to, if any.
timepointstring or nullformat: "^-?P(?:[0-9]+D)?(?:T(?:[0-9]+H)?(?:[0-9]+M)?(?:[0-9]+(?:\.[0-9]+)?S)?)?$"
The timepoint of this reserved sample, if any.
studyobject
The study a record belongs to, as embedded in animals, dosages, measurements, observations and samples. Carries the same attributes as a study retrieved directly, except that the project is given as an identifier rather than an embedded object, and the graph calculation settings are omitted.
created_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error