Search for ontology terms

post

https://BASE_PATH/layar/ontologyTerm/search

Find ontology terms by their ID or other object parameters.

Body Params

fromDate

date-time

Starting date formatted as YYYY-MM-DD

string

The query string to search for

rows

int32

The number of results to return

sort

string

The result value to sort by

sortOrder

string

The order to sort by (ex- 'ASC' or 'DESC')

start

int32

The index of the row to start returning values from

toDate

date-time

Ending date formatted as YYYY-MM-DD

dbIds

array of strings

limit results to terms with specific IDs

dbIds

documentIds

array of strings

limit results to terms from specific documents

documentIds

idPaths

array of strings

limit results to terms with specific ID paths

idPaths

includeObsolete

boolean

include obsolete terms in the results

namePaths

array of strings

limit results to terms with specific name paths

namePaths

pathTraversal

string

enum

limit results based on a specific traversal strategy when restricting by idPath or namePath

Allowed:

terms

array of strings

limit results to terms matching the supplied terms (in either name or synonym)

terms

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK