Data Metrics Server REST API Reference

UnboundID Logo

/eventTypes

GET

Available Since: 4.5

Return a list of Event types that have been produced by the instances specified by the query parameters over the specified time range.

Parameters

name description type default
instance The specific product instance IDs to match. If not specified all instances are used. Valid instance IDs are contained in the id attribute of the result from resource InstancesResource. query
instanceType The product instance types to match. If not specified all instance types are matched. To match more than one instance type, specify this parameter multiple times. A list of valid instance types will be returned in an error message if an invalid value is provided. query
startTime The start time for the requested data. This value may be in a relative form which will be calculated relative to endTime, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: -N[mhdwMy] which is interpreted to mean N time-units before endTime. Absolute form uses the ISO8601 syntax of

YYYY-MM-DDThh:mm:ss

where you can specify a partial date by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013.

query -24h
endTime The end time for the requested data. If not specified, an endTime of 'now' is used. This value may be in a relative form which will be calculated relative to now, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: -N[mhdwMy] which is interpreted to mean N time-units before now where now is the current time on the Data Metrics Server. Absolute form uses the ISO8601 syntax of

YYYY-MM-DDThh:mm:ss

where you can specify a partial string by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013.

query

Response Body

element: (custom)
media types: application/xml
application/json

A list of Strings that contain the matching event types.

Status Codes

code description
200 OK Success
400 Bad Request Invalid parameter
500 Internal Server Error Internal error