CAcancer
glossary

Return a list of glossary entries

get/rest/glossary/{version}

Request

Path parameters

versionstring required

Glossary version

Query parameters

qstring

Search query

statusstring[]

The status of the glossary item. This field only exists on development databases.

assigned_tostring

Only include glossary items with this assigned_to value.

categorystring[]

Limit the search to specific glossary item categories

modified_fromstring

Include all glossary items modified on or after the supplied date. Dates have the format of YYYY-MM-DD.

modified_tostring

Include all glossary items modified on or before the supplied date. Dates have the format of YYYY-MM-DD.

published_fromstring

Include all glossary items published on or after the supplied date. Dates have the format of YYYY-MM-DD.

published_tostring

Include all glossary items published on or before the supplied date. Dates have the format of YYYY-MM-DD.

been_publishedboolean

If 'true', only include tumors that been published; if 'false', only include glossary items that have never been published.

hiddenboolean

If 'true', only return glossary items that are hidden

mode'AND' | 'OR'

Search mode

countinteger

The number of results to return

offsetinteger

Results start at this offset

order'name' | '-name' | 'status' | '-status' | 'assigned_to' | '-assigned_to' | 'last_modified' | '-last_modified' | 'type' | '-type' | 'site_category' | '-site_category' | 'icdO3_morphology' | '-icdO3_morphology'

The sort order of the results

output_type'MIN' | 'PARTIAL' | 'FULL'

Output type

glossaryboolean

Return glossary matches

Response

Success

termsstring[]
totalinteger
countinteger
offsetinteger
max_scorenumber double
orderstring

Changes

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