Skip to main content

GetIndexes

Lists index definitions, including parameter configurations on the same property.

Parameters​

  • index_type (optional): entity or connection; defaults to both.
  • class (optional): Filter by entity or connection class.
  • property_key (optional): Filter by property.
  • kind (optional): ordered, trigram, or type; defaults to all.

The response contains indexes and returned (the number of definitions). Each entry contains index_id, index_type, class, property_key, kind, normalized params, version, and type_versions. An empty result has indexes: [] and returned: 0.

The published entities and connections summaries are also retained. They group indexed properties by class, with index_type: "VALUE_INDEX" and an observed property_type. Parameter variants share one class/property summary. Entity class values are objects; connection class values are arrays. Each summary retains its own returned count of observed property-type records; the top-level returned counts complete index definitions.

Examples​


    [{
        "GetIndexes": {
            "index_type": "entity",
            "class": "Person"
        }
    }]