Skip to navigation
APIsTeam Glossary ResourcesSample Glossary

Update team sample glossary items

Updates between 1 and 100 sample types in your team’s glossary, including archiving and unarchiving them through status. The request is validated as a whole; if any item is invalid, none are updated. The response lists only the sample types that changed. System sample types cannot be updated.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Headers

X-Studies-Api-VersionstringOptional

Request

The changes to apply, one item per sample type.
idstringRequiredformat: "^tgy_[a-zA-Z0-9]{10,22}$"
Unique identifier for an entry in your team's own glossary.
titlestringOptional1-255 characters
The title of the sample type. Must not be blank, must be unique among your team's sample types, and cannot change while samples use the sample type.
labelstringOptional1-20 characters
A short label for the sample type. Must not be blank and must be unique among your team's sample types.
statusenumOptional
Whether a team glossary entry is available for use or archived.
Allowed values:
descriptionstring or nullOptional
A longer description of the sample type.
detailslist of enumsOptional
The details to record when a sample of this type is collected. An empty list removes them all.
Allowed values:

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 updated sample types.
datalist of objects
The sample types.

Errors

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