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

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

Report exports

Request

Use this API to asynchronously generate reports across supported report types. After you submit your report generation requests, they are processed in the background. Once complete, you receive a unique URI in the response header.

NOTE: You need to specify the columns you want to return in the report, and apply filter criteria to refine the data returned. To find out what columns and filter criteria are available, call the Report Exports Metadata API.

Security

BearerAuth

Bodyapplication/json

namestring

The name of the report.

descriptionstring

A short summary of the report.

kindstring

typestring

The type of the resource.

definitionobject(reportDefinition)

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/reporting/public/openapi/reporting-nbapi-v1alpha1/reporting/v1alpha1/report-exports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Request accepted

Headers

Locationstring(uri)

URL where the generated resource can be accessed

Example: "/reporting/v1alpha1/async-operations/1fa85f64-5434-9980-b3fc-3c963f44fgh9"

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)

UUID of generated resource

namestring(string)

The name of the resource

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string"
}

Report exports metadata

Request

This API is a support tool that assists with generating a report. Use it to find the supported columns, filter criteria, and values for a report type. In a response, the API returns:

columns—An array containing the supported columns.
filterCriteria—An array comprising of filter names and their corresponding data types.
supportedOperators—A collection of supported operators assisting you in selecting the correct operator to use in a filter attribute. The following operators are supported:
- EQ—Checks if a field is equal to a value.
- NE—Checks if a field is not equal to a value.
- LT—Checks if a field is less than a value.
- LE—Checks if a field is less than or equal to a value.
- GT—Checks if a field is greater than a value.
- GE—Checks if a field is greater than or equals to a value.
- IN—Checks if a value is in a list.

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.

CLASS	EXAMPLES
Types	integer, decimal, timestamp, string, boolean, null
Operations	eq, ne, gt, ge, lt, le, in
Logic	and, or, not

Examples:

Filter with multiple operations

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

filter=name ne Subscriptions and group eq Device inventory

selectstringrequired

The select query parameter is used to limit the properties returned for a resource. The value of the select query parameter is a comma-separated list of properties.

Example: equals=[object Object]

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:

Ascending by name

Order ascending by name

sort=name asc

Ascending by name and then by descending by createdAt

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=10

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/report-exports-metadata?filter=string&equals=%5Bobject+Object%5D&sort=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Request accepted

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

itemsArray of objects(reportDoc)required

items[].idstring(uuid)required

The unique identifier of the report.

items[].kindstringrequired

items[].typestringrequired

The type of the resource.

items[].namestringrequired

The name of the report.

items[].columnsArray of objectsrequired

items[].columns[].displayNamestringrequired

The display name of the column.

items[].columns[].namestringrequired

The internal name of the column.

items[].columns[].dataTypestringrequired

The classification of data accepted by the column.

items[].filterCriteriaArray of objectsrequired

items[].filterCriteria[].namestringrequired

The name of the filter criteria.

items[].filterCriteria[].dataTypestringrequired

The classification of data accepted by the column.

items[].filterCriteria[].supportedOperatorsArray of stringsrequired

The classification of the logical operator supported by the filter criteria.

countintegerrequired

Number of items returned

totalintegerrequired

Total number of items in the collection that match the filter query, if one was provided in the request.

offsetintegerrequired

Zero-based resource offset to start the response from

Response

application/json

{
  "items": [
    { … }
  ],
  "count": 0,
  "total": 0,
  "offset": 0
}

Async operations

Operations

Report Filters

Operations

HPE GreenLake for Reporting (v1alpha1)

Report Status

Report exports

Report exports

Request

Responses

Was this helpful?

Report exports metadata

Request

Responses

Was this helpful?

Async operations

Report Filters

HPE GreenLake for Reporting (v1alpha1)

Report Status

Report exports

Report exports

RequestExpand all

Responses

Was this helpful?

Report exports metadata

Request

Responses

Was this helpful?

Async operations

Report Filters

Request