Skip to navigation
APIsTeam Glossary ResourcesSample Glossary

Create team sample glossary items

Adds between 1 and 100 sample 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 sample types to add.
titlestringRequired1-255 characters
The title of the sample type. Must not be blank and must be unique among your team's sample types.
labelstring or nullOptional<=20 characters
A short label for the sample type. Must be unique among your team's sample types.
descriptionstring or nullOptional<=255 characters
A longer description of the sample type.
detailslist of enums or nullOptional
The details to record when a sample of this type is collected.
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 created sample types.
datalist of objects
The sample types.

Errors

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