# ApiTimeSeriesEntityType Data Model

Describe a time series entity type and attributes associated with this entity type.

Available since API v11.

Properties
name | data type | description
--- | --- | ---
name | string | Returns the name of the entity type. This name uniquely identifies this entity type.
category | string | Returns the category of the entity type.
nameForCrossEntityAggregateMetrics | string | Returns the string to use to pluralize the name of the entity for cross entity aggregate metrics.
displayName | string | Returns the display name of the entity type.
description | string | Returns the description of the entity type.
immutableAttributeNames | array of string | Returns the list of immutable attributes for this entity type. Immutable attributes values for an entity may not change over its lifetime.
mutableAttributeNames | array of string | Returns the list of mutable attributes for this entity type. Mutable attributes for an entity may change over its lifetime.
entityNameFormat | array of string | Returns a list of attribute names that will be used to construct entity names for entities of this type. The attributes named here must be immutable attributes of this type or a parent type.

entityDisplayNameFormat

string

Returns a format string that will be used to construct the display name of entities of this type. If this returns null the entity name would be used as the display name. The entity attribute values are used to replace $attribute name portions of this format string. For example, an entity with roleType "DATANODE" and hostname "foo.com" will have a display name "DATANODE (foo.com)" if the format is "$roleType ($hostname)".

parentMetricEntityTypeNames

array of string

Returns a list of metric entity type names which are parents of this metric entity type. A metric entity type inherits the attributes of its ancestors. For example a role metric entity type has its service as a parent. A service metric entity type has a cluster as a parent. The role type inherits its cluster name attribute through its service parent. Only parent ancestors should be returned here. In the example given, only the service metric entity type should be specified in the parent list.

Example

    {
      "name" : "...",
      "category" : "...",
      "nameForCrossEntityAggregateMetrics" : "...",
      "displayName" : "...",
      "description" : "...",
      "immutableAttributeNames" : [ "...", "..." ],
      "mutableAttributeNames" : [ "...", "..." ],
      "entityNameFormat" : [ "...", "..." ],
      "entityDisplayNameFormat" : "...",
      "parentMetricEntityTypeNames" : [ "...", "..." ]
    }