Get an Entity Type
get
/serviceapi/entityModel/uds/entityTypes/{entityType}
Retrieves the entity type definitions.
Request
Supported Media Types
- application/json
Path Parameters
-
entityType: string
the name of the entity type(s) to be looked up
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : UdsEntityType
Type:
object
Describes an entity type.
-
entityType:
string
The entity typeExample:
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 nameExample:
My Host Type
Nested Schema : metrics
Type:
array
The metrics for this entity type
Show Source
-
Array of:
object UdsMetricType
Describes a metric type.
Nested Schema : properties
Type:
array
The Properties for this entity type
Show Source
-
Array of:
object UdsPropertyType
Describes a property type.
Nested Schema : UdsMetricType
Type:
object
Describes a metric type.
-
dimensions(optional):
array dimensions
The dimensions of this metric
-
group(optional):
string
The metric group nameExample:
cpuUtil
-
metric:
string
The metric nameExample:
cpuIdle
-
type:
string
The metric typeExample:
NUM
Nested Schema : UdsPropertyType
Type:
object
Describes a property type.
-
displayName:
string
The display name of a propertyExample:
listen port
-
identifyingProperty:
boolean
Default Value:
false
The identifying propertyExample:false
-
name:
string
The name of the propertyExample:
port
Examples
Get the MyHostType type definition:
curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://serverurl/serviceapi/entityModel/uds/entityTypes/MyHostType"
Result:
{ "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