Skip to navigation
APIsTeam Glossary ResourcesOther Glossary

Retrieve a team glossary item

Retrieves the details of an existing team glossary entry.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

teamGlossaryIdstringRequiredformat: "^tgy_[a-zA-Z0-9]{10,22}$"
The unique identifier of the team 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 team glossary entry.
idstringformat: "^tgy_[a-zA-Z0-9]{10,22}$"
Unique identifier for an entry in your team's own glossary.
titlestring<=255 characters
The title of the team glossary entry.
labelstring or null<=20 characters
A short label for the team 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:
descriptionstring or null
A longer description of the team glossary entry.
typeenum

How values are recorded against a team glossary entry. numeric entries have a configured min/max range, severity entries accept Mild/Moderate/Severe, and none entries carry free-form text with no structured value.

Allowed values:
statusenum
Whether a team glossary entry is available for use or archived.
Allowed values:
optionsobject or null

Type-specific configuration for this glossary entry. Null when the entry has no numeric bounds or sample-collection details.

Errors

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