Retrieve a sample definition
Retrieves a sample definition planned on a study.
Authentication
AuthorizationBearer
OAuth authentication of the form <token>.
Path parameters
studyId
The unique identifier of the study.
definitionId
The unique identifier of the sample definition.
Headers
X-Studies-Api-Version
Response headers
X-RateLimit-Limit
The number of requests permitted in the current rate limit window.
X-RateLimit-Remaining
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-Reset
The number of seconds until the current rate limit window resets.
Response
The requested sample definition.
id
Unique identifier for a sample definition, the template a planned sample was created from.
sample_type
The team glossary sample type a sample definition collects.
name
The name of the sample definition.
timepoints
When the sample is collected, as offsets from the collection schedule's reference point. Empty when no timepoint is planned.
details
The details to record on each sample collected. Empty when none are planned.
metadata
Free-form custom fields, keyed by glossary slug. Keys must resolve to terms in the team’s glossary for the owning resource; values may be strings, numbers, booleans or arrays. On read, values belonging to lookup-type slugs are URL-encoded.
study
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.
created_at
UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.
updated_at
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