Get a list of wellness events

get/events

Retrieves a list of wellness events, in descending order of creation time so that the most recent events are listed first.

Pagination— This endpoint exclusively supports cursor-based pagination, using the next query parameter.

Filtering— The following are the supported filter parameters:

  • condition/severity
  • status/currentState
  • supportCase/caseNumber
  • productName
  • serviceName
  • flag
  • archive
  • read
  • createdAt
  • updatedAt
SecurityBearer
Request
query Parameters
filter
string

The filter query parameter is used to filter a set of resources. The returned set of resources matches the criteria in the filter query parameter. The value of the filter query parameter is a subset of OData V4 filter expressions consisting of simple comparison operations joined by logical operators.

Note: You cannot use the filter and text-search parameters in the same query.

Examples:
Retrieve events with severity 'warning'.
filter=condition/severity eq 'warning'
Retrieve events that belong to productName 'HPE Alletra 9000'.
filter=productName eq 'HPE Alletra 9000'
Retrieve events that belong to specified services.
filter=serviceName in ('Storage', 'Networking')
Retrieve events that are flagged.
filter=flag eq true
Retrieve events that are not archived.
filter=archive ne true
Retrieve events that contains the given number in the support case number.
filter=contains(supportCase/caseNumber, '523')
Retrieve events created before the given timestamp.
filter=createdAt lt 2021-05-12T07:20:00.00Z
Retrieve events created between the given timestamps.
filter=createdAt gt 2021-05-12T07:20:00.00Z and createdAt lt 2022-05-12T07:20:00.00Z
Retrieve events with severity 'warning' and that belong to productName 'HPE Alletra 9000'.
filter=condition/severity eq 'warning' and productName eq 'HPE Alletra 9000'
text-search
string [ 2 .. 100 ] characters

Searches for wellness events that contain the given search string. A search string can include alphanumeric characters, a space character (Unicode U+0020) or a hyphen (-). Apart from space characters and hyphens, no other special characters are supported. Including an unsupported character might cause inaccurate results. The minimum length of a search string is 2 characters and maximum is 100 characters.

  • title
  • condition.category
  • condition.name
  • condition.severity
  • asset.name
  • asset.product
  • asset.urn
  • status.currentStatus
  • supportCase.casenumber
  • supportCase.casestatus
  • serviceName
  • productName

    Note: You cannot use the filter and text-search parameters in the same query.
Examples:
text-search=temperature
select
string

The select query parameter is used to limit the properties returned for support cases. The value of the select query parameter is a comma separated list of properties. All properties are returned if the select parameter is omitted.

Note: Only the total property is supported.

Examples:
Retrieve the total count of events for the current filter.
select=total
limit
integer <int32> [ 1 .. 200 ]
Default: 100

Specifies the number of resources (wellness events) to fetch.

next
string

The next parameter represents the ID of an event used as a pagination cursor to retrieve the next set of wellness events. The parameter must be a valid UUID and be a part of the response of the previous request.

Examples:
Event ID as pagination cursor
next=0908777a-788f-45da-afb8-295c626e4d14
Responses
200

OK

400

Bad Request

401

Unauthorized - Invalid JWT token in Request

429

You have exceeded the allowed rate limit. Please contact HPE support if it is an error.

500

Unexpected Server Error. Please re-try and contact HPE support if the error is not resolved.

Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "count": 2,
  • "next": "0001b67f-9518-4d0f-9b17-70cec7763632",
  • "total": 300
}