v2

latestOpenAPI 3.1.02026-07-263155112.9 KB

text_annotation

Post Ground

post/v3/api/ground

Request body

contentstring required

prefixstring[] nullable

categoryEntityCategory[] nullable

Response

Successful Response

idstring required

categorystring nullable

namestring nullable

xrefstring[] nullable

synonymstring[] nullable

full_namestring nullable

The long form name of an entity

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.

symbolstring nullable

file_sourcestring nullable

Source file stem injected by koza at load time.

provided_bystring nullable

typestring nullable

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

descriptionstring nullable

iristring nullable

has_attributestring[] nullable

has_biological_sexstring nullable

The biological sex of an individual entity.

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.

same_asstring[] nullable

subsetsstring[] nullable

A list of subsets that the entity belongs to

synonymsstring nullable

has_genestring[] 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