Get HPO Term Descendants
get_term_descendantsRead-onlyIdempotent
Retrieve all specific descendant phenotype terms of an HPO term using transitive is_a hierarchy, with pagination support for large result sets.
Instructions
Return all transitive is_a descendants (more specific phenotype terms) of an HPO term via the precomputed closure, with a pagination block {total, returned, limit, offset, truncated, next_offset}. When truncated, next_commands carries a forward-page step (offset) so you can walk a >limit closure without re-sending rows. Use get_term_children for only the immediate children. Signature: get_term_descendants(term, limit=, offset=, response_mode=).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| term | Yes | An HP id (HP:0000118), a phenotype label/synonym, or an external xref CURIE that resolves to a single HPO term. | |
| limit | No | Max rows returned (default 50). | |
| offset | No | Rows to skip for forward paging (default 0). | |
| response_mode | No | Verbosity: minimal|compact|standard|full (default compact). | compact |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| success | No | ||
| _meta | No | ||
| error_code | No | ||
| message | No | ||
| retryable | No | ||
| recovery_action | No | ||
| field | No | ||
| allowed_values | No | ||
| hint | No | ||
| candidates | No | ||
| hpo_id | No | ||
| name | No | ||
| total | No | ||
| returned | No | ||
| limit | No | ||
| offset | No | ||
| next_offset | No | ||
| truncated | No | ||
| descendants | No | ||
| hpo_version | No |