Skip to content
Internal API Catalog
/
HPE GreenLake for Wellness
/
API Reference
/
Support Cases

HPE GreenLake for Wellness (v2)

The HPE GreenLake for Wellness APIs facilitates the automation of IT operations by enabling you to monitor wellness events related to your infrastructure. To further streamline integration workflows, these APIs provide various filtering options and KPI metrics.

Download OpenAPI description
OpenApi-v2.json
OpenApi-v2.yaml
Overview
License

HPE License

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/wellness/public/openapi/wellness-service/openapi-v2/

https://global.api.greenlake.hpe.com/wellness/v2/

Events

Wellness events provide health insights about your HPE products and services and show information about automatically created support cases. Wellness events allow you to:

  • Identify potential vulnerabilities before they affect your environment.
  • Proactively monitor the health of your HPE products and services.
  • View AI-powered recommendations about events.

Operations

Support Cases

Create and retrieve support cases associated with wellness events.

Operations

Create a support case

Request

Create a support case for a wellness event. This is an asynchronous operation. Use the URI specified in the Location response header to retrieve the status of the case creation operation.

Security
Bearer
Bodyapplication/jsonrequired

Request Body

eventobject(EventResourceRef)

Reference to the wellness event.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/wellness/public/openapi/wellness-service/openapi-v2/support-cases \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "event": {
      "resourceUri": "/wellness/v2/events/00000010-7e93-4046-9adc-1397cd6ab2d1",
      "id": "00000010-7e93-4046-9adc-1397cd6ab2d1"
    }
  }'

Responses

OK

Headers
Locationstring(uri-reference)

URI to get details of the support case creation operation.

Examples:
/wellness/v2/async-operations/00000010-7e93-4046-9adc-1397cd6ab2d1
Bodyapplication/json
Response
application/json
null

Get a list of support cases

Request

Retrieves a list of support cases associated with wellness events. The results are in descending order of creation time, so that the most recent support cases are listed first.

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

Filtering: The following are the supported filter parameters :

  • event/id — The event/id filter parameter only supports the eq operator and its value should be a valid wellness event ID.
  • caseNumber
  • status
  • createdAt
  • updatedAt
  • event/condition/severity
  • event/status/currentState
  • event/productName
  • event/serviceName
  • event/createdAt
  • event/updatedAt
Security
Bearer
Query
filterstring

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.

Examples:
filter=event/id eq 3fa85f64-5717-4562-b3fc-2c963f66afa6
filter=event/createdAt lt 2021-05-12T07:20:00.00Z
filter=event/createdAt gt 2021-05-12T07:20:00.00Z
filter=createdAt lt 2021-05-12T07:20:00.00Z
filter=createdAt gt 2021-05-12T07:20:00.00Z and createdAt lt 2022-05-12T07:20:00.00Z
selectstring

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 only the count of support cases for the current filter.

select=total
limitinteger(int32)[ 1 .. 200 ]

Specifies the number of support cases to be returned.

Default 100
nextstring

Specifies the event ID, which acts as the pagination cursor for the next page of support cases.

Examples:

Event ID

next=0908777a-788f-45da-afb8-295c626e4d14
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/wellness/public/openapi/wellness-service/openapi-v2/support-cases \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects(supportCase)<= 200 itemsrequired
items[].​idstringrequired

Unique identifier of the case.

items[].​typestringrequired

The type of the resource.

Value "wellness/support-case"
items[].​generationinteger(int32)>= 0required

Monotonically increasing update counter to track the support case version.

items[].​createdAtstring(date-time)required

The date and time of support case creation.

items[].​updatedAtstring(date-time)required

The last date and time the support case was updated.

items[].​resourceUristring(uri-reference)

URI to the support case.

items[].​caseNumberstring

The case number assigned to the support case.

items[].​eventobject(EventResourceRef)

Reference to the wellness event.

items[].​userstring

The first and last name of the user that escalated the wellness event. Only relevant to manually escalated cases.

items[].​crmstring

The customer relationship management (CRM) system used to create the support case.

items[].​statusstring

The current status of the support case.

Enum"open""closed""escalated"
items[].​caseHistoryArray of objects(caseHistoryData)

Case update history.

countinteger(int32)[ 0 .. 200 ]required

Number of items (support cases) returned.

totalinteger(int32)>= 0required

Total number of items (support cases) for the current filter criteria.

nextstring

Support case ID, which acts as the pagination cursor for the next page of support cases.

Response
application/json
{
  "items": [
    { … },
    { … }
  ],
  "count": 2,
  "next": "000000d0-a3c9-4dc2-aacb-d85973efbdf3",
  "total": 300
}

Get support case with specific ID

Request

Retrieves a support case identified by the given ID.

Security
Bearer
Path
idstringrequired

The support case ID.

Examples:

Returns support case that match given event ID.

ab23434cs
curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/wellness/public/openapi/wellness-service/openapi-v2/support-cases/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstringrequired

Unique identifier of the case.

typestringrequired

The type of the resource.

Value "wellness/support-case"
generationinteger(int32)>= 0required

Monotonically increasing update counter to track the support case version.

createdAtstring(date-time)required

The date and time of support case creation.

updatedAtstring(date-time)required

The last date and time the support case was updated.

resourceUristring(uri-reference)

URI to the support case.

caseNumberstring

The case number assigned to the support case.

eventobject(EventResourceRef)

Reference to the wellness event.

userstring

The first and last name of the user that escalated the wellness event. Only relevant to manually escalated cases.

crmstring

The customer relationship management (CRM) system used to create the support case.

statusstring

The current status of the support case.

Enum"open""closed""escalated"
caseHistoryArray of objects(caseHistoryData)

Case update history.

Response
application/json
{
  "id": "41495911",
  "caseNumber": "47758",
  "type": "wellness/support-case",
  "resourceUri": "/wellness/v2/support-cases/41495911",
  "event": {
    "resourceUri": "/wellness/v2/events/00006e2e-e02c-4cb3-ba40-d9d8ae2fdb24",
    "id": "00006e2e-e02c-4cb3-ba40-d9d8ae2fdb24"
  },
  "createdAt": "2023-11-12T12:18:59.983Z",
  "updatedAt": "2024-02-02T16:32:19.983Z",
  "generation": 1,
  "status": "open"
}

Async Operations

Asynchronous APIs are APIs that do not return data immediately. This means you can make multiple requests at once. A high-level overview of the asynchronous API process:

  1. You make a request to an asynchronous API endpoint.
  2. HPE GreenLake returns an acknowledgment, typically a 202 Accepted, and provides a URI to the async-operation resource in the Location header.
  3. HPE GreenLake continues to process the request.
  4. When completed, HPE GreenLake returns the requested information.

Operations