Skip to content
Internal API Catalog
/
HPE GreenLake for Reporting
/
Report Status

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

Get statuses of all the reports belonging to a workspace

Request

This API is designed to fetch the status of all reports for a specific workspace. Only reports belonging to the workspace ID and username are returned. This API supports pagination, allowing you to use offset and limit parameters.

Security
BearerAuth
Query
filterstringrequired

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents.

For example, the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASSEXAMPLES
Typesinteger, decimal, timestamp, string, boolean, null
Operationseq, ne, gt, ge, lt, le, in
Logicand, or, not
Examples:

Return results where a property equals a value. <property> eq <value>

filter=type eq 'REPORT'
sortstringrequired

The order in which to return the resources in the collection.The value of the sort query parameter is a comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.

Examples:

Order ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
limitinteger[ 0 .. 100 ]

The maximum number of reports to return.

Default 10
Example: limit=50
offsetinteger

Zero-based resource offset to start the response from.

Default 0
Example: offset=20
curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/reporting/public/openapi/reporting-nbapi-v1alpha1/reporting/v1alpha1/statuses?filter=string&sort=string' \
  -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
countinteger

Number of items returned

limitinteger

The maximum number of reports to return.

offsetinteger

Zero-based resource offset

itemsArray of objects
Response
application/json
{
  "count": 0,
  "limit": 0,
  "offset": 0,
  "items": [
    { … }
  ]
}

Get Report Status by ID

Request

Retrieve the status of a specific report by passing the report status ID.

Security
BearerAuth
Path
idstring(uuid)^[a-zA-Z0-9-]+$required

The report status identifier.

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/statuses/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

Unique identifier of the report

typestringrequired

Type of the resource

statusstringrequired

The current status of the report generation stage, indicating whether the stage is, for example, in progress or completed.

stagestringrequired

The current stage in the report generation process.

messagestringrequired

A short description of the current progress. This field may be empty.

reportTypestringrequired

The type of report.

userNamestringrequired

The username of whoever created the report.

recipientEmailIdstringrequired

The email address the report was sent to.

startTimestring(date-time)required

The date and time the report request was initiated.

statusTimestampstring(date-time)required

The date and time the report request was initiated.

namestring
descriptionstring
resourceUristring

URI to the report status resource itself.

isExpiredstring

A boolean that declares if the report has expired or not.

reportDownloadUrlstring

The URL at which you can view the report.

createdAtstring(date-time)

The date and time the report request was initiated.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "string",
  "name": "string",
  "description": "string",
  "resourceUri": "string",
  "status": "string",
  "stage": "string",
  "message": "string",
  "isExpired": "string",
  "reportType": "string",
  "reportDownloadUrl": "string",
  "userName": "string",
  "recipientEmailId": "string",
  "startTime": "2019-08-24T14:15:22Z",
  "statusTimestamp": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}

Report exports

Operations

Async operations

Operations

Report Filters

Operations