Skip to content
Internal API Catalog
/
HPE GreenLake for Reporting
/
Async operations

HPE GreenLake for Reporting (v1alpha1)

The HPE GreenLake for Reporting service provides a collection of RESTful APIs for generating reports, retrieving supported columns and filters, monitoring asynchronous operations, and querying the status of reports.

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE License

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/reporting/public/openapi/reporting-nbapi-v1alpha1/

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

Report Status

Operations

Report exports

Operations

Async operations

Operations

Asynchronous operation details

Request

Retrieve information about asynchronous operations within the reporting service. Provide the unique identifier of the operation in the parameter to monitor the progress of asynchronous tasks. This API returns the following attributes:

  • status—Indicates the current status of the asynchronous task.
  • startedAt—Specifies the timestamp when the operation was initiated.
  • endedAt—Indicates the timestamp when the operation was completed.
  • logMessages—Provides a list of progress updates for the asynchronous operation.
  • progressPercent—Represents the progress of the operation as a percentage value ranging from 0 to 100.
  • sourceResourceUri—References the source URI that triggered the asynchronous task.
  • results—The results array provides a link to /reporting/v1alpha1/statuses/{id} to get the complete details of the report status.
Security
BearerAuth
Path
idstring(uuid)^[a-zA-Z0-9-]+$required

The unique identifier returned by an asynchronous API call.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/reporting/public/openapi/reporting-nbapi-v1alpha1/reporting/v1alpha1/async-operations/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Headers
Deprecationstring

Provides information about when it will be deprecated

Example: "Sun, 11 Nov 2018 23:59:59 GMT"
Sunsetstring

Provides information about when it will become unresponsive

Example: "Wed, 11 Nov 2020 23:59:59 GMT"
Bodyapplication/json
idstring(uuid)required

The primary identifier for the resource.

typestringrequired

The type of the resource.

statestringrequired

The state of the operation.

logMessagesArray of objectsrequired

List of progress update objects. This array can be empty.

logMessages[].​timestampstring(date-time)

The date and time the log messag was created.

logMessages[].​messagestring

The log message describing the progress update.

progressPercentinteger(int64)required

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

sourceResourceUristringrequired

The URI reference to the resource or resource collection that initiated the operation

startedAtstring(date-time)

The date and time the operation entered the RUNNING state.

endedAtstring(date-time)

The date and time the operation completed in the SUCCEEDED, FAILED, or CANCELLED states.

resultsArray of objects

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

errorobject
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "string",
  "state": "string",
  "startedAt": "2019-08-24T14:15:22Z",
  "endedAt": "2019-08-24T14:15:22Z",
  "logMessages": [
    { … }
  ],
  "progressPercent": 0,
  "sourceResourceUri": "string",
  "results": [
    { … }
  ],
  "error": {
    "message": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "debugId": "string"
  }
}

Report Filters

Operations