Skip to navigation
APIsStudy ResourcesStudy Requests

Retrieve a study request

Retrieves the details of an existing study request.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

studyIdstringRequiredformat: "^sdy_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study.
requestIdstringRequiredformat: "^req_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study request.

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 study request.
idstringformat: "^req_[a-zA-Z0-9]{10,22}$"
Unique identifier for a study request.
user_idstringformat: "^usr_[a-zA-Z0-9]{10,22}$"
Unique identifier for a user.
assigned_user_idstring or nullformat: "^usr_[a-zA-Z0-9]{10,22}$"
The user assigned to fulfil the request.
statusenum
The status of a study request.
Allowed values:
due_datedate or null
The date the request is due.
groupslist of objects
The form groups on the request.
fieldslist of objects
The form fields on the request.
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.
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