Skip to navigation
APIsGlobal ResourcesGlossary

Retrieve a glossary item

Retrieves the details of an existing shared glossary entry.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

glossaryIdstringRequiredformat: "^gly_[a-zA-Z0-9]{10,22}$"
The unique identifier of the glossary.

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 glossary entry.
idstringformat: "^gly_[a-zA-Z0-9]{10,22}$"
Unique identifier for an entry in the shared glossary, which is maintained across all teams rather than by your team.
titlestring<=255 characters
The title of the glossary entry.
groupenum

The group a glossary entry belongs to. Shared glossary entries used by the public API are typically euthanize reasons; team glossary entries may also be sample or observation types.

Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error