Get Indexes table

This endpoint retrieves the details of a given Indexes table.

Method	Path	Operation*
GET	/account/services/indexes/{index}	get_indexes_table

*

In order for a user to perform the "get_indexes_table" operation, the "get_indexes_table" permission must be included in the list of allowed actions in the statement of the user's role.

Request

Parameter	Type	In	Description
index required	string	path	Name of the Indexes table to be retrieved.

Response

Attribute	Type	Description
stats	dictionary	Indexes table stats. Attribute Type Description table_size integer Size, in bytes, of actual data stored in the database table backing the Index. index_size integer Size, in bytes, of indices created on the database table backing the index. toast_size integer Size, in bytes, of the TOAST (The Oversized-Attribute Storage Technique(opens new window)) data for the database table backing the index. total_size integer Total size, in bytes, of the database relation (sum of actual, indices and toast data) backing the index.
properties	dictionary	Dictionary containing a list of property names and a list of data types of the properties. Attribute Type Description names list of strings Name/names of the property/properties. Each of the names must match the regular expression(opens new window) ^[a-z_][0-9a-z_]{0,63}$. types list of strings, value is "bigint", "bool", "boolean", "character varying", "date", "double precision", "geography", "geometry", "int", "integer", "interval", "json", "jsonb", "numeric", "real", "smallint", "text", "time", "timestamp", "timestamptz", "varchar", or "uuid". Data types of the properties.
rule	string	Rule used to select Twins that should be present in the given Indexes table. This rule is evaluated when the Ledger is changed. It is not evaluated when a user or a Twin are changed.
templates	dictionary	Dictionary containing templates for "properties" in form of key-value pairs: - key: property name, - value: template. The templates follow the Python string str.format() convention (see Format String Syntax(opens new window)).
database	string	Database UUID.

Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.