CLclinia
Vocabularies

Search for concepts in the terminology

Search for concepts in the terminology.

post/terminology/v1/vocabularies/{vocabularyKey}/concepts/query

Request

  • Base URL
    https://.clinia.cloud
  • URL
    https://.clinia.cloud/terminology/v1/vocabularies/{vocabularyKey}/concepts/query
  • Auth
    API key in header X-Clinia-API-Key

Path parameters

vocabularyKeystring required

The key of the vocabulary. It can be the wildcard '*' to search in all vocabularies.

Request body

highlightingstring[]
pageinteger
perPageinteger
traversedPropertiesstring[]

The properties from the relationships or adjacent records that will be returned in the search response. The wildcard '*' can be used in itself or in combination with a prefix

  • * will return all traversed properties.
  • @worksAt.* will return all traversed properties from the relationship 'worksAt'.
  • @worksAt.@clinic.* will return all traversed properties from an adjacent 'clinic' connected with a 'worksAt' relationship.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.