Skip to navigation
APIsStudy ResourcesStudy Animal Observations

Retrieve an observation for a study animal

Retrieves a single observation recorded against a specific animal on a study.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

studyIdstringRequiredformat: "^sdy_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study.
animalIdstringRequiredformat: "^aml_[a-zA-Z0-9]{10,22}$"
The unique identifier of the animal.
observationIdstringRequiredformat: "^obs_[a-zA-Z0-9]{10,22}$"
The unique identifier of the observation.

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 observation.
idstringformat: "^obs_[a-zA-Z0-9]{10,22}$"
Unique identifier for an observation.
glossary_idstring or nullformat: "^gly_[a-zA-Z0-9]{10,22}$"

The shared glossary entry the observation was recorded against. Null for a free-form observation, and for one recorded against an entry your team defined itself rather than one from the shared glossary.

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

Your team’s glossary entry the observation was recorded against. Null for a free-form observation.

titlestring or null<=255 characters
The name of the glossary entry the observation was recorded against.
labelstring or null<=20 characters
The short label your team has given the glossary entry, for use where the full title does not fit.
textstring or null

The free-form note recorded.

typeenum or null

How value should be interpreted.

Allowed values:
valuestring or null<=255 characters

The reading recorded against the glossary entry, as a string regardless of type. A numeric observation holds the number as text; a severity observation holds one of the entry’s configured options.

observed_atdatetime or null

The time the observation was made, which may be earlier than created_at when it was recorded retrospectively.

studyobject or null
The study the animal was on when the observation was made. Null when the animal is not on a study.
animalobject
The animal a record belongs to, as embedded in dosages, measurements, observations and samples. Carries the same attributes as an animal retrieved directly, except that the cage, study and treatment group are given as identifiers rather than embedded objects.
userobject or null
The user who recorded the observation.
created_atdatetime

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

updated_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