API Reference

Get asynchronous operation details

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

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

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:

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

Operations

Get a list of asynchronous operations

Request

Retrieves a list of all asynchronous operations organized in descending order based on their creation time. This ensures the most recent asynchronous operations are presented first.

Pagination: This endpoint exclusively supports cursor-based pagination.

Filtering: The following are the supported filter parameters:

state— The state filter parameter only supports the eq operator and its value should be a valid string.
createdAt
updatedAt
endedAt
startedAt

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:

Retrieve a list of asynchronous operations that are in the given `state` filter=state eq SUCCEEDED

Retrieve a list of asynchronous operations initiated before the given timestamp filter=createdAt lt 2021-05-12T07:20:00.00Z

Retrieve a list of asynchronous operations initiated after the given timestamp filter=createdAt gt 2021-05-12T07:20:00.00Z

Retrieve a list of asynchronous operations that went into the `RUNNING` state after the given timestamp filter=startedAt gt 2021-05-12T07:20:00.00Z

Retrieve a list of asynchronous operations initiated between the given timestamps filter=createdAt gt 2021-05-12T07:20:00.00Z and createdAt lt 2022-05-12T07:20:00.00Z

limitinteger(int32)[ 1 .. 200 ]

Specifies the number of asynchronous operations to be returned.

Default 100

nextstring

Specifies the ID, which acts as the pagination cursor for the next page of asynchronous operations.

Examples:

Async Operation 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/async-operations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

itemsArray of objects(AsyncOperation)<= 200 itemsrequired

items[].idstring(uuid)required

Primary identifier for the asynchronous operation given by the system.

items[].typestringrequired

The type of the resource.

Value "wellness/async-operation"

items[].generationinteger(int32)>= 0required

Monotonically increasing update counter.

items[].createdAtstring(date-time)required

The time at which this asynchronous operation is submitted.

items[].updatedAtstring(date-time)required

The time at which this asynchronous operation is last updated.

items[].startedAtstring(date-time)required

Time at which the operation entered the RUNNING state.

items[].endedAtstring(date-time)required

Time at which the operation completed (entered a SUCCEEDED, FAILED, or CANCELLED state).

items[].sourceResourceUristring(uri-reference)required

URI reference to the resource that initiated the operation.

items[].statestringrequired

State of the operation.

Enum"INITIALIZED""RUNNING""PAUSED"

items[].logMessagesArray of asyncOpLogMessage (objects) or nullrequired

One of:

A list of progress update objects, which may be empty.

<= 0 items

items[].logMessages[].messagestring

Description of a recorded state of an asynchronous operation.

items[].logMessages[].timestampstring(date-time)

The time at which the state of asynchronous operation is recorded.

items[].progressPercentinteger(int32)[ 0 .. 100 ]required

Percent progress of the operation as an integer value of 0 to 100.

items[].errorApiError (object) or nullrequired

One of:

API Error Object.

items[].error.errorCodestringrequired

A unique machine-friendly, but human-readable identifier for the error

items[].error.messagestringrequired

User-friendly error message

items[].error.debugIdstring(uuid)required

Unique identifier for the instance of this error

items[].error.httpStatusCodeinteger(int32)[ 400 .. 599 ]required

HTTP equivalent status code

items[].suggestedPollingIntervalSecondsinteger(int32)[ 30 .. 360000 ]

Number of seconds recommended for clients to poll for updates.

items[].timeoutMinutesinteger(int32)[ 1 .. 1 ]

Number of minutes after the last update before the operation moves into the TIMEDOUT state.

items[].resultsArray of asyncOpResult (objects) or null

One of:

List of references to resources (other than the source resource) which were created, updated, or deleted during the operation.

<= 1 items

countinteger(int32)[ 1 .. 200 ]required

Number of items (asynchronous operations) returned.

Default 100

totalinteger(int32)>= 0required

Total number of items (asynchronous operation) for the current filter criteria.

nextstring(uuid)

The asynchronous operation ID acts as the pagination cursor for the next page of resources.

Response

application/json

{
  "items": [
    { … },
    { … }
  ],
  "count": 2,
  "next": "0001b67f-9518-4d0f-9b17-70cec7763632",
  "total": 300
}

Get asynchronous operation details

Request

Retrieves asynchronous operation details identified with a specific ID.

Security

Bearer

Path

idstring(uuid)required

The asynchronous operation id returned in an ansychronous API response.

Examples:

Example with specific ayschronous operation ID

Returns details of the asynchronous operation that matches the given ID.

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/async-operations/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

idstring(uuid)required

Primary identifier for the asynchronous operation given by the system.

typestringrequired

The type of the resource.

Value "wellness/async-operation"

generationinteger(int32)>= 0required

Monotonically increasing update counter.

createdAtstring(date-time)required

The time at which this asynchronous operation is submitted.

updatedAtstring(date-time)required

The time at which this asynchronous operation is last updated.

startedAtstring(date-time)required

Time at which the operation entered the RUNNING state.

endedAtstring(date-time)required

Time at which the operation completed (entered a SUCCEEDED, FAILED, or CANCELLED state).

sourceResourceUristring(uri-reference)required

URI reference to the resource that initiated the operation.

statestringrequired

State of the operation.

Enum"INITIALIZED""RUNNING""PAUSED"

logMessagesArray of asyncOpLogMessage (objects) or nullrequired

One of:

A list of progress update objects, which may be empty.

<= 0 items

logMessages[].messagestring

Description of a recorded state of an asynchronous operation.

logMessages[].timestampstring(date-time)

The time at which the state of asynchronous operation is recorded.

progressPercentinteger(int32)[ 0 .. 100 ]required

Percent progress of the operation as an integer value of 0 to 100.

errorApiError (object) or nullrequired

One of:

API Error Object.

error.errorCodestringrequired

A unique machine-friendly, but human-readable identifier for the error

error.messagestringrequired

User-friendly error message

error.debugIdstring(uuid)required

Unique identifier for the instance of this error

error.httpStatusCodeinteger(int32)[ 400 .. 599 ]required

HTTP equivalent status code

suggestedPollingIntervalSecondsinteger(int32)[ 30 .. 360000 ]

Number of seconds recommended for clients to poll for updates.

timeoutMinutesinteger(int32)[ 1 .. 1 ]

Number of minutes after the last update before the operation moves into the TIMEDOUT state.

resultsArray of asyncOpResult (objects) or null

One of:

List of references to resources (other than the source resource) which were created, updated, or deleted during the operation.

<= 1 items

Response

application/json

{
  "id": "00006e2e-e02c-4cb3-ba40-d9d8ae2fdb24",
  "type": "wellness/async-operation",
  "generation": 1,
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-02-01T12:00:00Z",
  "startedAt": "2024-01-01T12:00:00Z",
  "endedAt": "2024-01-01T12:05:00Z",
  "sourceResourceUri": "/wellness/v2/events/00000010-7e93-4046-9adc-1397cd6ab2d1",
  "state": "SUCCEEDED",
  "logMessages": null,
  "progressPercent": 100,
  "error": null,
  "suggestedPollingIntervalSeconds": 30,
  "timeoutMinutes": 1,
  "results": [
    { … }
  ]
}

HPE GreenLake for Wellness (v2)

Events

Support Cases

Async Operations

Get a list of asynchronous operations

Request

Responses

Was this helpful?

Get asynchronous operation details

Request

Responses

Was this helpful?