CAcancer
disease

Return a list of Disease entries

This API call returns both Hematopoietic and Solid Tumor data. The Solid Tumor data, however, is being provided as a preview only. In order to retrieve data that is ready for use in your systems, please make sure to include the HEMATO type parameter when retrieving disease data. If you do not provide a parameter, you will be retrieving data for both Hematopoietic and Solid Tumors.

get/rest/disease/{version}

Request

Path parameters

versionstring required

Disease version

Query parameters

qstring

Search query

statusstring[]

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

assigned_tostring

Only include disease items with this assigned_to value

site_categorystring[]

Limit the search to a site category of diseases. For a list of categories, see disease/site_categories

type'SOLID_TUMOR' | 'HEMATO' | 'NON_NEOPLASTIC'

Disease classification.

modified_fromstring

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

modified_tostring

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

published_fromstring

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

published_tostring

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

been_publishedboolean

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

hiddenboolean

If 'true', only return disease 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.