Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListVocabulariesRequest

Hierarchy

Index

Properties

Optional MaxResults

MaxResults: undefined | number

The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

Optional NameContains

NameContains: undefined | string

Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

Optional NextToken

NextToken: undefined | string

If your ListVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Optional StateEquals

StateEquals: VocabularyState | string

Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.