Skip to navigation
APIsTeam Glossary ResourcesObservation Glossary

Create team observation glossary items

Adds between 1 and 100 observation types to your team’s glossary. The request is validated as a whole; if any item is invalid, none are created.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Headers

X-Studies-Api-VersionstringOptional

Request

The observation types to add.
titlestringRequired1-255 characters
The title of the observation type. Must not be blank and must be unique among your team's observation types.
typeenumRequired

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:
labelstring or nullOptional<=20 characters
A short label for the observation type. Must be unique among your team's observation types.
descriptionstring or nullOptional<=255 characters
A longer description of the observation type.
numericobject or nullOptional

The bounds of the observation type. Required when type is numeric, with a finite, non-negative min below max; must be omitted or null otherwise.

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

Errors

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