Jump to

• Request
• Response
• Examples

Get Entity Types

get

/serviceapi/entityModel/uds/entityTypes

Retrieves a list of entity types.

Request

Supported Media Types

• application/json

Query Parameters

• entityType(optional): string
  the name of the entity type(s) to be looked up, support wild card character
• limit(optional): integer(int32)
  the number of entries in the result to be returend in one REST call

  Default Value: 2000
• offset(optional): integer(int32)
  the offset into the result list when doing a query with limit

  Default Value: 0

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : ItemListUdsEntityType

Type: object

Show Source

• count: integer(int32)
  The number of items in the list
• hasMore: boolean
  Default Value: false

  Indicates if there are more items
• items: array items
  The items
• nextLink(optional): string
  The link to get the next chunk of items (if paging)
• previousLink(optional): string
  The link to the previous chunk of items (if paging)
• totalCount(optional): integer(int32)
  The total number of items (if paging)

{
    "type":"object",
    "required":[
        "count",
        "hasMore",
        "items"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in the list"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more items",
            "default":false
        },
        "items":{
            "type":"array",
            "description":"The items",
            "items":{
                "$ref":"#/definitions/UdsEntityType"
            }
        },
        "nextLink":{
            "type":"string",
            "description":"The link to get the next chunk of items (if paging)"
        },
        "previousLink":{
            "type":"string",
            "description":"The link to the previous chunk of items (if paging)"
        },
        "totalCount":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of items (if paging)"
        }
    }
}

Nested Schema : items

Type: array

The items

Show Source

• Array of: object UdsEntityType

  Describes an entity type.

{
    "type":"array",
    "description":"The items",
    "items":{
        "$ref":"#/definitions/UdsEntityType"
    }
}

Nested Schema : UdsEntityType

Type: object

Describes an entity type.

Show Source

• entityType: string
  The entity type

  Example: my_host
• metrics(optional): array metrics
  The metrics for this entity type
• properties(optional): array properties
  The Properties for this entity type
• typeDisplayName(optional): string
  The entity type display name

  Example: My Host Type

{
    "type":"object",
    "required":[
        "entityType"
    ],
    "properties":{
        "entityType":{
            "type":"string",
            "example":"my_host",
            "description":"The entity type"
        },
        "metrics":{
            "type":"array",
            "description":"The metrics for this entity type",
            "items":{
                "$ref":"#/definitions/UdsMetricType"
            }
        },
        "properties":{
            "type":"array",
            "description":"The Properties for this entity type",
            "items":{
                "$ref":"#/definitions/UdsPropertyType"
            }
        },
        "typeDisplayName":{
            "type":"string",
            "example":"My Host Type",
            "description":"The entity type display name"
        }
    },
    "description":"<p>Describes an entity type.</p>"
}

Nested Schema : metrics

Type: array

The metrics for this entity type

Show Source

• Array of: object UdsMetricType

  Describes a metric type.

{
    "type":"array",
    "description":"The metrics for this entity type",
    "items":{
        "$ref":"#/definitions/UdsMetricType"
    }
}

Nested Schema : properties

Type: array

The Properties for this entity type

Show Source

• Array of: object UdsPropertyType

  Describes a property type.

{
    "type":"array",
    "description":"The Properties for this entity type",
    "items":{
        "$ref":"#/definitions/UdsPropertyType"
    }
}

Nested Schema : UdsMetricType

Type: object

Describes a metric type.

Show Source

• dimensions(optional): array dimensions
  The dimensions of this metric
• group(optional): string
  The metric group name

  Example: cpuUtil
• metric: string
  The metric name

  Example: cpuIdle
• type: string
  The metric type

  Example: NUM

{
    "type":"object",
    "required":[
        "metric",
        "type"
    ],
    "properties":{
        "dimensions":{
            "type":"array",
            "description":"The dimensions of this metric",
            "items":{
                "type":"string"
            }
        },
        "group":{
            "type":"string",
            "example":"cpuUtil",
            "description":"The metric group name"
        },
        "metric":{
            "type":"string",
            "example":"cpuIdle",
            "description":"The metric name"
        },
        "type":{
            "type":"string",
            "example":"NUM",
            "description":"The metric type"
        }
    },
    "description":"<p>Describes a metric type.</p>"
}

Nested Schema : dimensions

Type: array

The dimensions of this metric

Show Source

• Array of: string

{
    "type":"array",
    "description":"The dimensions of this metric",
    "items":{
        "type":"string"
    }
}

Nested Schema : UdsPropertyType

Type: object

Describes a property type.

Show Source

• displayName: string
  The display name of a property

  Example: listen port
• identifyingProperty: boolean
  Default Value: false

  The identifying property

  Example: false
• name: string
  The name of the property

  Example: port

{
    "type":"object",
    "required":[
        "displayName",
        "identifyingProperty",
        "name"
    ],
    "properties":{
        "displayName":{
            "type":"string",
            "example":"listen port",
            "description":"The display name of a property"
        },
        "identifyingProperty":{
            "type":"boolean",
            "example":false,
            "description":"The identifying property",
            "default":false
        },
        "name":{
            "type":"string",
            "example":"port",
            "description":"The name of the property"
        }
    },
    "description":"<p>Describes a property type.</p>"
}

Back to Top

Examples

Get all Entity Types which start with My:

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://serverurl/serviceapi/entityModel/uds/entityTypes?entityType=My*"

Result:

{
  "count": 1,
  "items": [
    {
      "entityType": "MyHostType",
      "typeDisplayName": "My Host Type",
      "metrics": [
        {
          "metric": "cpuIdle",
          "type": "NUM",
          "dimensions": [
            "cpuId"
          ]
        },
        {
          "metric": "cpuSystem",
          "type": "NUM",
          "dimensions": [
            "cpuId"
          ]
        },
        {
          "metric": "cpuUser",
          "type": "NUM",
          "dimensions": [
            "cpuId"
          ]
        }
      ]
    }
  ]
}

Back to Top