MOmonarchinitiative
text_annotation

Ground

Changed on
get/v3/api/ground

Request

  • Base URL
    https://monarchinitiative.org (the document declares no server; this is the origin it was published from)
  • URL
    https://monarchinitiative.org/v3/api/ground
  • Auth
    none declared

Query parameters

textstring
prefixstring[] nullable
categoryEntityCategory[] nullable
include_phenotypesboolean

Include each match's phenotype annotations and their closures. Large: these are most of the response when present.

include_descendantsboolean

Include each match's ontology descendants. Large: these are most of the response when present.

Response

Successful Response

idstring required
categorystring nullable
namestring nullable
descriptionstring nullable
xrefstring[] nullable
synonymstring[] nullable
exact_synonymstring[] nullable

An exact synonym for the entity

broad_synonymstring[] nullable

A broader synonym for the entity

narrow_synonymstring[] nullable

A narrower synonym for the entity

related_synonymstring[] nullable

A related synonym for the entity

deprecatedboolean nullable

A boolean flag indicating that an entity is no longer considered current or valid.

in_taxonstring nullable

The biolink taxon that the entity is in the closure of.

in_taxon_labelstring nullable

The label of the biolink taxon that the entity is in the closure of.

iristring nullable
same_asstring[] nullable
subsetsstring[] nullable

A list of subsets that the entity belongs to

file_sourcestring nullable

Source file stem injected by koza at load time.

provided_bystring nullable
full_namestring nullable

The long form name of an entity

symbolstring nullable
has_genestring[] nullable
typestring nullable

The type of the entity (e.g. sequence onotology type for genes etc)

has_attributestring[] nullable
has_biological_sexstring nullable

The biological sex of an individual entity.

synonymsstring nullable
namespacestring nullable

The namespace/prefix portion of this entity's identifier

has_phenotypestring[] nullable

A list of phenotype identifiers that are known to be associated with this entity

has_phenotype_labelstring[] nullable

A list of phenotype labels that are known to be associated with this entity

has_phenotype_countinteger nullable

A count of the number of phenotypes that are known to be associated with this entity

has_phenotype_closurestring[] nullable

A list of phenotype identifiers that are known to be associated with this entity expanded to include all ancestors

has_phenotype_closure_labelstring[] nullable

A list of phenotype labels that are known to be associated with this entity expanded to include all ancestors

has_descendantstring[] nullable

A list of entity identifiers that are known to be descendants of this entity

has_descendant_labelstring[] nullable

A list of entity labels that are known to be descendants of this entity

has_descendant_countinteger nullable

A count of the number of entities that are known to be descendants of this entity

Changes

  • 00871419e83eRevision changes
    • info

      added the new optional query request parameter include_descendants

    • info

      added the new optional query request parameter include_phenotypes

    • info

      added the enum value biolink:ClinicalMeasurement to the property anyOf[subschema #1]/items/ of the query request parameter category

  • 1dd6862950fcRevision changes
    • info

      added the new optional query request parameter category

    • info

      added the new optional query request parameter prefix