Skip to content
Internal API Catalog
/
Data Services API
/
settings

Data Services API (1.3.0)

Data Services API

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/

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

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

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

async-operations

Async Operations API

Operations

dual-auth-operations

Dual Authorization API

Operations

issues

Issues API

Operations

secret-assignments

Secret Assignment Management APIs

Operations

secrets

Secret Management APIs

Operations

settings

Settings API

Operations

List settings for the current account.

Request

Returns all settings values for the current account

Security
bearer
Query
offsetinteger

Use offset in conjunction with limit for paging. The offset is the number of items from the beginning of the result set to the first item included in the response.

limitinteger[ 1 .. 100 ]

Use limit in conjunction with offset for paging. The limit is the maximum number of items to include in the response.

Default 10
filterstring

The expression to use for filtering responses. You can filter on the following properties: customerId, id, name, possibleValues, currentValue, settingDescription, lastUpdatedBy, lastUpdatedAt, externalApplicationName. You can combine multiple comparison operators using AND. The comparisons supported are the following: “eq” : Valid for number, boolean and string properties. “gt” : Valid for number or string timestamp properties. “lt” : Valid for number or string timestamp properties “in” : Valid for an array of strings Syntax: “eq” : filter=<property> eq <value> {host:port}/data-services/v1beta1/settings?filter=<property> eq <value> “gt” : filter=<property> gt <value> {host:port}/data-services/v1beta1/settings?filter=<property> gt <value> “lt” : filter=<property> lt <value> {host:port}/data-services/v1beta1/settings?filter=<property> lt <value> “in” : filter=<property> in <value> {host:port}/data-services/v1beta1/settings?filter=<property> in <value>

  • Use AND to filter on multiple properties: {host:port}/data-services/v1beta1/settings?filter=<property1> eq <value1> and <property2> lt <value2>
  • To filter multiple values on one property e.g. filter=name in ('foo','bar') {host:port}/data-services/v1beta1/settings?filter=foo%bar%20in%20severity Examples: GET /data-services/v1beta1/settings?filter=name eq 'SETTINGNAME' GET /data-services/v1beta1/settings?filter=name eq 'SETTINGNAME' and lastUpdatedBy eq 'CREATED' GET /data-services/v1beta1/settings?filter=relatedObjectType in ('NIMBLE-VOLUME') Filters are supported on following attributes: customerId, id, name, possibleValues, currentValue, settingDescription, lastUpdatedBy, lastUpdatedAt, externalApplicationName
sortstring

The property to sort by followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified the default order is ascending.

selectstring

A comma-separated list of properties to include in response. If this is omitted, all properties are returned.

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Settings list

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(Setting)required
items[].​idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].​typestringread-onlyrequired

The type of resource.

items[].​generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].​createdAtstring(date-time)required
items[].​updatedAtstring(date-time)required
items[].​resourceUristringread-onlyrequired

The self reference for this resource.

items[].​customerIdstringread-onlyrequired

The customer application identifier

items[].​namestring

A system specified name for the resource.

items[].​consoleUristring

The URI for console screen that displays this resource

items[].​currentValuestring

Value of the setting

items[].​descriptionstring

Description of the setting

items[].​externalApplicationNamestring

Name of the application to be displayed in UI

items[].​lastUpdatedAtstring(-time)

Time when this setting was last updated for this account. RFC 3339

items[].​lastUpdatedBystring

UserId of the user who last updated this setting for this account

items[].​nextValuestring

Next possible value of the setting, which is updated by the workflow

items[].​possibleValuesstring

A JSON array (stored as string) containing possible values of this setting

totalinteger

Total number of items matching the filter parameter in the request.

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

Returns setting with given Id

Request

Returns the details of the setting with the given ID. If a value does not exist for the setting, the API returns the default value.

Security
bearer
Path
idstring(uuid)required

The ID of the setting

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/settings/c1a0eb78-41a0-4151-93b2-f057ffeca3f3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Setting Detail

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required
updatedAtstring(date-time)required
resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

namestring

A system specified name for the resource.

consoleUristring

The URI for console screen that displays this resource

currentValuestring

Value of the setting

descriptionstring

Description of the setting

externalApplicationNamestring

Name of the application to be displayed in UI

lastUpdatedAtstring(-time)

Time when this setting was last updated for this account. RFC 3339

lastUpdatedBystring

UserId of the user who last updated this setting for this account

nextValuestring

Next possible value of the setting, which is updated by the workflow

possibleValuesstring

A JSON array (stored as string) containing possible values of this setting

Response
application/json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "consoleUri": "string",
  "currentValue": "string",
  "description": "string",
  "externalApplicationName": "string",
  "lastUpdatedAt": "string",
  "lastUpdatedBy": "string",
  "nextValue": "string",
  "possibleValues": "string"
}

Update a setting

Request

Changes the value of the given setting.

Security
bearer
Path
idstring(uuid)required

The ID of the setting

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3
Bodyapplication/merge-patch+jsonrequired
currentValuestringrequired

New value of the Value setting

curl -i -X PATCH \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/settings/c1a0eb78-41a0-4151-93b2-f057ffeca3f3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "currentValue": "string"
  }'

Responses

Patch Setting

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required
updatedAtstring(date-time)required
resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

namestring

A system specified name for the resource.

consoleUristring

The URI for console screen that displays this resource

currentValuestring

Value of the setting

descriptionstring

Description of the setting

externalApplicationNamestring

Name of the application to be displayed in UI

lastUpdatedAtstring(-time)

Time when this setting was last updated for this account. RFC 3339

lastUpdatedBystring

UserId of the user who last updated this setting for this account

nextValuestring

Next possible value of the setting, which is updated by the workflow

possibleValuesstring

A JSON array (stored as string) containing possible values of this setting

Response
application/json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "consoleUri": "string",
  "currentValue": "string",
  "description": "string",
  "externalApplicationName": "string",
  "lastUpdatedAt": "string",
  "lastUpdatedBy": "string",
  "nextValue": "string",
  "possibleValues": "string"
}

software-releases

Software Releases

Operations

storage-locations

storage-locations API.

Operations

tags

Tags APIs

Operations