Skip to navigation
APIsCage Resources

Create a cage

Creates a cage, optionally assigned to a study. The service generates a name and catalog number when no name is supplied.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Headers

X-Studies-Api-VersionstringOptional

Request

The attributes of the cage to create.
study_idstring or nullOptionalformat: "^sdy_[a-zA-Z0-9]{10,22}$"
The study to assign the cage to.
namestring or nullOptional1-50 characters
The cage name. Generated when omitted or null.
metadatamap from strings to any or nullOptional
The metadata to associate to the cage.

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 cage was created.
idstringformat: "^cge_[a-zA-Z0-9]{10,22}$"
Unique identifier for a cage.
namestring<=50 characters
The name of the cage.
catalogstring or null<=255 characters
The generated catalog number of the cage.
metadatamap from strings to any or null
The metadata associated to the cage.
studyobject or null
The study the cage belongs to. Null when it is not assigned to a study.
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
429
Too Many Requests Error