Skip to navigation
APIsTeam Glossary ResourcesObservation Glossary

Update team observation glossary items

Updates between 1 and 100 observation 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 observation types that changed. System observation 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 observation 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 observation type. Must not be blank, must be unique among your team's observation types, and cannot change while observations use the observation type.
labelstringOptional1-20 characters
A short label for the observation type. Must not be blank and must be unique among your team's observation types.
descriptionstring or nullOptional
A longer description of the observation type. Null clears it.
statusenumOptional
Whether a team glossary entry is available for use or archived.
Allowed values:
typeenumOptional

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:
numericobject or nullOptional

The bounds to change. Only allowed when the resulting type is numeric. Changing the type away from numeric drops the stored bounds; null is accepted then but rejected while the type stays numeric.

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

Errors

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