Skip to navigation
APIsStudy ResourcesStudy Planned Animals

Retrieve a planned animal

Retrieves a planned animal on a study. A planned animal that does not exist, has been removed or belongs to another team returns 403; one that belongs to another study on your team returns 404.

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: "^adf_[a-zA-Z0-9]{10,22}$"
The unique identifier of the planned animal.

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 planned animal.
idstringformat: "^adf_[a-zA-Z0-9]{10,22}$"
Unique identifier for a planned animal on a study.
planned_idstring<=40 characters
The identifier your team gave the planned animal within its study.
strainstring or null<=255 characters
The strain the animal is planned to be.
speciesstring or null<=255 characters
The species of the planned strain. Null when no strain is planned.
sexenum or null
The sex the animal is planned to be.
Allowed values:
metadatamap from strings to any or null
The metadata assigned to the planned animal. Null when none is assigned.
animal_idstring or nullformat: "^aml_[a-zA-Z0-9]{10,22}$"
The animal assigned to the plan. Null until one is assigned.
studyobject or null
The study the animal is planned on.
study_groupobject or null
The group the animal is planned for. Null when no group is planned.
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