entity-grid

Get generic entity grid with configurable associations

Changed on

Returns a generic entity × entity grid with configurable association categories.

This endpoint allows you to specify:
- **column_association_category**: One or more association categories for the
  context → column hop (e.g., causal gene-disease, correlated gene-disease)
- **row_association_category**: The association category for the column → row hop
- **row_grouping**: How to group rows (histopheno for body systems, or none)
- **group_columns_by_category**: Whether to sort columns by their source association

Example: To get a grid of diseases (causal + correlated) and their phenotypes for a gene:
```
GET /entity-grid/HGNC:4851?column_association_category=biolink:CausalGeneToDiseaseAssociation
    &column_association_category=biolink:CorrelatedGeneToDiseaseAssociation
    &row_association_category=biolink:DiseaseToPhenotypicFeatureAssociation
    &group_columns_by_category=true
```

The response includes source_association_category on each column entity,
allowing the frontend to display different column groups.
get/v3/api/entity-grid/{context_id}

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/entity-grid/{context_id}
  • Auth
    none declared

Path parameters

context_idstring required

Context entity ID (gene, disease, etc.)

Example:HGNC:4851

Query parameters

column_association_categoryAssociationCategory[] required

Association category/categories for context → column

row_association_categoryAssociationCategory[] required

Association category/categories for column → row

row_grouping'histopheno' | 'none'

Row grouping options.

How to group rows

group_columns_by_categoryboolean

Sort columns by association category

directboolean

Only include direct associations (not via closure)

limitinteger

Maximum number of column entities

Response

Successful Response

context_idstring required

The identifier of the context entity (e.g., disease, gene)

context_namestring nullable

The name of the context entity

context_categorystring required

The biolink category of the context entity

total_columnsinteger required

Total number of column entities in the grid

total_rowsinteger required

Total number of row entities in the grid

cellsobject required

Map of column_id:row_id to cell data

Changes

    • breaking

      removed the enum value biolink:ChemicalOrDrugOrTreatmentToDiseaseOrPhenotypicFeatureAssociation from the property items/ of the query request parameter column_association_category

    • breaking

      removed the enum value biolink:ChemicalOrDrugOrTreatmentToDiseaseOrPhenotypicFeatureAssociation from the property items/ of the query request parameter row_association_category

    • info

      added the enum value biolink:ChemicalOrDrugOrTreatmentAdverseEventAssociation to the property items/ of the query request parameter column_association_category

    • info

      added the enum value biolink:ChemicalOrDrugOrTreatmentAdverseEventAssociation to the property items/ of the query request parameter row_association_category