Skip to content
/Order Data

HPE Flex Solutions (v1beta1)

This is the API reference document for the HPE Flex Solutions data service. It provides endpoints to view and manage Flex device and orders solutions.

Download OpenAPI description
flex-api.json
flex-api.yaml
Overview
License

HPE License

Languages
Servers

https://us-west.api.greenlake.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/flex/public/openapi/flex-service/v1beta1/flex-api/

Order Data

Operations

Get and search for orders

Request

This endpoint allows you to retrieve and search for orders. You can filter, sort, and paginate the results.
Pagination: This endpoint supports offset-based pagination using limit and offset parameters.

Security
Bearer
Query
filterstring

Filter expressions consisting of simple comparison operations joined by logical operators.
For the v1beta1 API, the following fields are supported for filtering under the ODATA specification:

  • id
  • billingAccountId
  • sowId
  • billingAccountName
  • customerName
  • resellerName
  • partnerName
  • distributorName
  • isFlexPartner
Examples:

Match all orders with given selected filters

filter=billingAccountId in ('HP-APJ-999-JPN-00104', 'HP-APUS-787-EN-00100') and billingAccountName eq 'accountname'

Match all orders with given selected filters

filter=sowId eq 'OPE-0011261086' and customerName eq 'HPE Tech Care'
selectstring

Comma separated list of fields to be returned in the response. If not provided, all fields will be returned.
All fields are supported.

Example: select=resellerName,billingAccountName,orderEndDate
sortstring

Comma separated list of fields to be sorted by in the response. The default sorting order is by orderEndDate in ascending order.

Example: sort=orderEndDate asc
offsetinteger>= 0

Zero-based resource offset to start the response from.

Default 0
Example: offset=10
limitinteger[ 0 .. 100 ]

Number of entities to return with a maximum of 100.

Default 20
Example: limit=30
curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/flex/v1beta1/orders \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
itemsArray of objects(Order)required
items[].​idstring(uuid)required

The unique ID of the order.

Example: "3b741a59-a22b-432f-b2cf-b72cc1a04c2d"
items[].​createdAtstring(date-time)required

Date of creation of the resource

Example: "2023-01-01T00:00:00Z"
items[].​updatedAtstring(date-time)required

Date of last update of the resource

Example: "2023-01-01T00:00:00Z"
items[].​typestringrequired

The type of resource.

Example: "flex/orders"
items[].​generationinteger(int32)required

Monotonically increasing update counter of the resource

Example: 1
items[].​billingAccountIdstringrequired

Unique ID of the billing account

Example: "HP-APJ-0012345678"
items[].​sowIdstringrequired

Unique ID of Start of Work (SOW) billing order

Example: "OPE-0011261086"
items[].​billingAccountNamestringrequired

Name of the billing account

Example: "Hewlett Packard Enterprise Cloud Storage"
items[].​orderStartDatestring(date-time)required

Date of order creation

Example: "2025-01-01T00:00:00Z"
items[].​orderEndDatestring(date-time)required

Date of order expiration

Example: "2035-01-01T00:00:00Z"
items[].​customerNamestringrequired

Name of the customer

Example: "Some Company Inc."
items[].​resellerNamestring

Name of the reseller

Example: "1st Street Resellers"
items[].​distributorNamestring

Name of the distributor

Example: "HPE Distributions"
items[].​partnerNamestring

Name of partnered vendor

Example: "Friendly Reseller LLC"
items[].​isFlexPartnerboolean

Whether the order is a Flex Partner order

Example: true
countintegerrequired

The number of returned items.

totalintegerrequired

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

offsetintegerrequired

The offset of the returned page.

Response
application/json
{
  "items": [
    { … }
  ],
  "count": 0,
  "total": 0,
  "offset": 0
}

Get distinct transformative data for orders

Request

This endpoint allows distinct transformative queries for orders.
A transform query applies a logical function to a resource set, such as aggregating by a element.
Pagination: This endpoint supports offset-based pagination using limit and offset parameters.

Security
Bearer
Query
group-bystringrequired

Field to be grouped by. Will return unique results of that type.
Supported fields are:

  • sowId
  • customerName
  • billingAccountName
  • billingAccountId
  • partnerName
    (partnerName is a unique combined set of resellerName and distributorName)
Example: group-by=partnerName
filterstring

Filter expressions consisting of simple comparison operations joined by logical operators.
For the v1beta1 API, the following fields are supported for filtering under the ODATA specification:

  • billingAccountId
  • sowId
  • billingAccountName
  • customerName
  • resellerName
  • distributorName
  • partnerName
Examples:

Match all orders with given selected filters

filter=billingAccountId in ('HP-APJ-999-JPN-00104', 'HP-APUS-787-EN-00100') and billingAccountName eq 'accountname'

Match all orders with given selected filters

filter=sowId eq 'OPE-0011261086' and customerName eq 'HPE Tech Care'
sortstring

Fields to be sorted by in the response. The default sorting order is by the group-by field in ascending order. The sort field must be one of the group-by fields, if given.

Example: sort=partnerName desc
offsetinteger>= 0

Zero-based resource offset to start the response from.

Default 0
Example: offset=10
limitinteger[ 0 .. 100 ]

Number of entities to return with a maximum of 100.

Default 20
Example: limit=30
curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/flex/v1beta1/orders/transform?group-by=partnerName' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
itemsArray of objects(OrderTransform)required
items[].​sowIdstring

The unique SOW ID.

Example: "OPE-123456789"
items[].​billingAccountIdstring

Unique billing account ID

Example: "HP-123456789"
items[].​billingAccountNamestring

Unique billing account name

Example: "Hewlett Packard Enterprise Cloud Storage"
items[].​customerNamestring

Unique customer name

Example: "Some Company Inc."
items[].​partnerNamestring

Unique partner name

Example: "HPE Distributions"
countintegerrequired
totalintegerrequired
offsetintegerrequired
Response
application/json
{
  "items": [
    { … }
  ],
  "count": 0,
  "total": 0,
  "offset": 0
}

Device Data

Operations