Skip to content
API reference
/
/
Delete a location

Locations API (v1)

Service to manage location information for HPE GreenLake platform.

Download OpenAPI description
openApi.json
openApi.yaml
Overview
License
HPE License
Languages
Servers
https://global.api.greenlake.hpe.com/
Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/location-management/public/openapi/locations-service-latest/v1/openapi/

Locations

Operations

Lists all locations

Request

Retrieve location information for all locations.

Security
Bearer
Query
limitinteger[ 1 .. 2000 ]required

The maximum number of results to be returned. A value below 1, above 2000 or that is not an integer returns 400.

Default 100
offsetinteger>= 0

The zero-based resource offset to start the response from. A negative or non-integer value returns 400.

Default 0
workspaceIdsArray of strings

Optional. Comma-separated workspace ids to restrict the consolidated list to, for an MSP or organization parent workspace. Ids outside the caller's scope are ignored; an empty intersection returns no items. For a non-parent workspace only its own id matches. Ignored unless the consolidated view is enabled for the caller.

filterstring

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.

Supported properties and operators:

  • name with contains, for example contains(name, 'test'). The match is not case-sensitive.
  • city and country with eq, for example city eq 'Austin'. The match is not case-sensitive, and a location matches when any of its addresses matches.
  • validated and validationExpired with eq true or eq false.
Only these combinations are supported, using and: city with country (for example country eq 'United States' and city eq 'Austin', which returns locations with an address that matches both), and validated with validationExpired (for example validated eq false and validationExpired eq false returns locations that were never validated). or, not, other operators, other combinations and a property given more than once return 400.

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.

Examples:

Return locations that contain a name that matches the one provided.

filter=contains(name, 'test')

Return locations belonging to the city that matches the one provided.

filter=city eq 'test city'

Return locations belonging to the country that matches the one provided.

filter=country eq 'test country'

Return locations with an address in the city and country provided.

filter=country eq 'test country' and city eq 'test city'

Return locations whose validation cycle has lapsed and need re-validation.

filter=validationExpired eq true

Return locations that are neither validated nor expired.

filter=validated eq false and validationExpired eq false
curl -i -X GET \
  'https://global.api.greenlake.hpe.com/locations/v1/locations?limit=100' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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

The unique identifier of the location.

items[].​citystring

The location's city.

items[].​countrystring

The location's country.

items[].​expiredAtstring or null

The date the location expired.

items[].​namestring

The name of the location.

items[].​validatedboolean

Boolean confirming whether the location has been validated or not.

Default true
items[].​validatedAtstring or null(date-time)

The date and time the location was validated, as an RFC 3339 timestamp in UTC.

items[].​validatedByEmailstring

Email address of the workspace user that validated the location.

items[].​validatedByNamestring

The name of the workspace user that validated the location.

items[].​validationCyclestring
Enum"""6""12"
items[].​validationExpiredboolean

A boolean confirming whether the location validation has expired or not.

Default false
items[].​latstring

Latitude coordinate of the location.

items[].​lngstring

Longitude coordinate of the location.

items[].​tagsArray of objects or null(server.GetTags)

Tags associated with the location.

countintegerrequired

Number of items returned

offsetintegerrequired

Zero-based resource offset

totalinteger

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

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

Create a Location

Request

Create a location and store its associated information.

Security
Bearer
Bodyapplication/jsonrequired

Location Information

addressesArray of objects(server.CreateAddressNBRequest)non-emptyrequired

Exactly one address of type street is required; one address of type shipping_receiving is optional.

addresses[].​citystring<= 60 charactersrequired

The location's city.

addresses[].​countrystring<= 100 charactersrequired

The location's country.

addresses[].​postalCodestring<= 20 charactersrequired

The location's postal code.

addresses[].​statestring<= 60 charactersrequired

The location's state or region.

addresses[].​streetAddressstring<= 100 charactersrequired

The location's street address.

addresses[].​typestringrequired

Only addresses of type “shipping_receiving” can be added during an add operation.

Value"shipping_receiving"
addresses[].​idstring(uuid)

The unique identifier of the address.

addresses[].​locationIdstring

The unique identifier of the location.

addresses[].​streetAddress2string

The location's street address.

contactsArray of objects(server.CreateContactsNBRequest)required

Locations must have one primary contact but can have more than one of the other contact types.

contacts[].​emailstring<= 100 charactersrequired

The email address associated with the contact.

contacts[].​namestring<= 100 charactersrequired

The name of the contact. For API-created locations with a non-GLP email, append "NONGLP" to the name (e.g., "John Doe NONGLP").

contacts[].​typestringrequired
Enum"primary""shipping_receiving""security"
contacts[].​idstring(uuid)

The unique identifier of the contact.

contacts[].​locationIdstring

The unique identifier of the location.

contacts[].​phoneExtensionstring<= 4 characters

The phone extension of the contact. Required only when the Phone Number is provided.

contacts[].​phoneNumberstring<= 20 characters

The phone number of the contact, [+][country code][phone number] format (e.g., +14155552671), without spaces or separators.

namestring<= 100 charactersrequired

Provide a descriptive name for the location.

locationTypestringrequired
Value"building"
descriptionstring

A long description of the location.

expiredAtstring

The date the location expired.

validatedboolean

Boolean confirming whether the location has been validated or not.

Default true
validatedAtstring(date-time)

The date and time the location was validated, as an RFC 3339 timestamp in UTC.

validatedByEmailstring

Email address of the workspace user that validated the location.

validatedByNamestring

The name of the workspace user that validated the location.

validationCyclestring
Enum"""6""12"
validationExpiredboolean

A boolean confirming whether the location validation has expired or not.

Default false
curl -i -X POST \
  https://global.api.greenlake.hpe.com/locations/v1/locations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "addresses": [
      {
        "city": "string",
        "country": "string",
        "postalCode": "string",
        "state": "string",
        "streetAddress": "string",
        "type": "shipping_receiving"
      }
    ],
    "contacts": [
      {
        "email": "string",
        "name": "string",
        "type": "primary"
      }
    ],
    "name": "string",
    "locationType": "building"
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)required

The unique identifier of the location.

typestringrequired

The type of the resource.

Value "locations/external-service"
createdAtstringrequired

The date and time the location was created.

updatedAtstringrequired

Time of the last update to the location.

generationintegerrequired

Monotonically increasing update counter.

addressesArray of objects(server.GetAddressNBResponse)
contactsArray of objects(server.GetContactNBResponse)

Locations must have one primary contact but can have more than one of the other contact types.

namestring

The name of the location.

locationTypestring
Value"building"
descriptionstring

A long descriptions of the location.

expiredAtstring

The date and time the location expired.

validatedboolean

Boolean confirming whether the location has been validated or not.

Default true
validatedAtstring(date-time)

The date and time the location was validated, as an RFC 3339 timestamp in UTC.

validatedByEmailstring

Email address of the workspace user that validated the location.

validatedByNamestring

The name of the workspace user that validated the location.

validationCyclestring
Enum"""6""12"
validationExpiredboolean

A boolean confirming whether the location validation has expired or not.

Default false
Response
application/json
{
  "addresses": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "locationType": "building",
  "createdAt": "string",
  "description": "string",
  "expiredAt": "string",
  "generation": 0,
  "type": "locations/external-service",
  "updatedAt": "string",
  "validated": true,
  "validatedAt": "2019-08-24T14:15:22Z",
  "validatedByEmail": "string",
  "validatedByName": "string",
  "validationCycle": "",
  "validationExpired": false
}

Retrieve a location

Request

Return information for a location specified by a location ID.

Security
Bearer
Path
idstring(uuid)required

The unique identifier of the location. For example, 945e70ec-b043-4cad-9ed0-069c06fdb8af.

curl -i -X GET \
  'https://global.api.greenlake.hpe.com/locations/v1/locations/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)required

The unique identifier for the location.

addressesArray of objects(server.GetAddressNBResponse)
contactsArray of objects(server.GetContactNBResponse)
descriptionstring or null

A long description of the location.

expiredAtstring or null

The date the location expired.

namestring

The name of the location.

locationTypestring
Value"building"
validatedboolean

Boolean confirming whether the location has been validated or not.

Default true
validatedAtstring or null(date-time)

The date and time the location was validated, as an RFC 3339 timestamp in UTC.

validatedByEmailstring

Email address of the workspace user that validated the location.

validatedByNamestring

The name of the workspace user that validated the location.

validationCyclestring
Enum"""6""12"
validationExpiredboolean

A boolean confirming whether the location validation has expired or not.

Default false
Response
application/json
{
  "addresses": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "description": "string",
  "expiredAt": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "locationType": "building",
  "validated": true,
  "validatedAt": "2019-08-24T14:15:22Z",
  "validatedByEmail": "string",
  "validatedByName": "string",
  "validationCycle": "",
  "validationExpired": false
}

Delete a location

Request

Delete a location by providing a specific location ID.

Security
Bearer
Path
idstring(uuid)required

The unique identifier for the location. For example, 945e70ec-b043-4cad-9ed0-069c06fdb8af.

curl -i -X DELETE \
  'https://global.api.greenlake.hpe.com/locations/v1/locations/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully deleted

Response
No content

Update a location

Request

Update a location's information by specifying its location ID. Only include the fields that need to be updated in the request body. Fields that are not included in the request body will remain unchanged.

Note: The name and locationType fields are mandatory and cannot be set to empty or invalid values.

Security
Bearer
Path
idstring(uuid)required

The unique identifier for the location.

Bodyapplication/merge-patch+jsonrequired

Updated Location Information

addressesArray of objects(server.UpdateAddressNBRequest)
contactsArray of objects(server.UpdateContactsNBRequest)
descriptionstring

A long description of the location.

expiredAtstring

The date the location expired.

namestring<= 100 characters

The name of location.

locationTypestring
Value"building"
validatedboolean

Boolean confirming whether the location has been validated or not.

Default true
validatedAtstring(date-time)

The date and time the location was validated, as an RFC 3339 timestamp in UTC.

validatedByEmailstring

Email address of the workspace user that validated the location.

validatedByNamestring

The name of the workspace user that validated the location.

validationCyclestring
Enum"""6""12"
validationExpiredboolean

A boolean confirming whether the location validation has expired or not.

Default false
curl -i -X PATCH \
  'https://global.api.greenlake.hpe.com/locations/v1/locations/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

OK

Bodyapplication/json
idstring(uuid)required

The unique identifier of the location.

typestringrequired

The type of the resource.

Value "locations/external-service"
createdAtstringrequired

The date and time the location was created.

updatedAtstringrequired

Time of the last update to the location.

generationintegerrequired

Monotonically increasing update counter.

addressesArray of objects(server.GetAddressNBResponse)
contactsArray of objects(server.GetContactNBResponse)

Locations must have one primary contact but can have more than one of the other contact types.

namestring

The name of the location.

locationTypestring
Value"building"
descriptionstring

A long descriptions of the location.

expiredAtstring

The date and time the location expired.

validatedboolean

Boolean confirming whether the location has been validated or not.

Default true
validatedAtstring(date-time)

The date and time the location was validated, as an RFC 3339 timestamp in UTC.

validatedByEmailstring

Email address of the workspace user that validated the location.

validatedByNamestring

The name of the workspace user that validated the location.

validationCyclestring
Enum"""6""12"
validationExpiredboolean

A boolean confirming whether the location validation has expired or not.

Default false
Response
application/json
{
  "addresses": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "locationType": "building",
  "createdAt": "string",
  "description": "string",
  "expiredAt": "string",
  "generation": 0,
  "type": "locations/external-service",
  "updatedAt": "string",
  "validated": true,
  "validatedAt": "2019-08-24T14:15:22Z",
  "validatedByEmail": "string",
  "validatedByName": "string",
  "validationCycle": "",
  "validationExpired": false
}

Manage a location

Request

Manage the location information for a location specified by its location ID. Provide information in the request body schema to create, update, or delete the location's address, contact, or location details. Only include the fields that need to be modified in the request body. Fields that are not included will remain unchanged.

Security
Bearer
Path
idstring(uuid)required

The unique identifier for the location. For example, 945e70ec-b043-4cad-9ed0-069c06fdb8af.

Bodyapplication/merge-patch+jsonrequired
addressesobject(server.UpdateAddressesPatchRequest)
contactsobject(server.UpdateContactsPatchRequest)
locationDetailsobject(server.LocationDetails)
curl -i -X PATCH \
  'https://global.api.greenlake.hpe.com/locations/v1/locations/update/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

OK

Bodyapplication/json
idstring(uuid)required

The unique identifier of the location.

typestringrequired

The type of the resource.

Value "locations/external-service"
createdAtstringrequired

The date and time the location was created.

updatedAtstringrequired

Time of the last update to the location.

generationintegerrequired

Monotonically increasing update counter.

addressesArray of objects(server.GetAddressNBResponse)
contactsArray of objects(server.GetContactNBResponse)

Locations must have one primary contact but can have more than one of the other contact types.

namestring

The name of the location.

locationTypestring
Value"building"
descriptionstring

A long descriptions of the location.

expiredAtstring

The date and time the location expired.

validatedboolean

Boolean confirming whether the location has been validated or not.

Default true
validatedAtstring(date-time)

The date and time the location was validated, as an RFC 3339 timestamp in UTC.

validatedByEmailstring

Email address of the workspace user that validated the location.

validatedByNamestring

The name of the workspace user that validated the location.

validationCyclestring
Enum"""6""12"
validationExpiredboolean

A boolean confirming whether the location validation has expired or not.

Default false
Response
application/json
{
  "addresses": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "locationType": "building",
  "createdAt": "string",
  "description": "string",
  "expiredAt": "string",
  "generation": 0,
  "type": "locations/external-service",
  "updatedAt": "string",
  "validated": true,
  "validatedAt": "2019-08-24T14:15:22Z",
  "validatedByEmail": "string",
  "validatedByName": "string",
  "validationCycle": "",
  "validationExpired": false
}

Get tags for a workspace

Request

Retrieve tag information for your workspace.

Security
Bearer
Query
limitinteger[ 1 .. 2000 ]required

The maximum number of results to be returned. A value below 1, above 2000 or that is not an integer returns 400.

Default 100
offsetinteger>= 0

The zero-based resource offset to start the response from. A negative or non-integer value returns 400.

Default 0
curl -i -X GET \
  'https://global.api.greenlake.hpe.com/locations/v1/locations/tags?limit=100' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects(server.LocationTags)required
items[].​namestringrequired

The tag name.

items[].​valuestringrequired

The tag value.

items[].​createdAtstringrequired

The date the location was created.

countintegerrequired

The number of items returned.

offsetintegerrequired

Zero-based resource offset

totalinteger

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

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

Create or delete a tag

Request

Use this API to create or delete a tag. In the request body, provide:

  • The tag name and tag value in the appropriate array to create (createTags) or delete (deleteTags) tags as needed.
  • The location ID.

Security
Bearer
Bodyapplication/merge-patch+jsonrequired

Update tags for a location

createTagsArray of objects(server.GetTags)

An array of key-value pairs to create new tags.

deleteTagsArray of objects(server.GetTags)

An array of key-value pairs to delete existing tags.

locationIdstring(uuid)

The unique identifier of the location.

curl -i -X PATCH \
  https://global.api.greenlake.hpe.com/locations/v1/locations/tags \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

OK

Bodyapplication/json
idstring(uuid)required

The unique identifier of the tag.

typestringrequired

The type of the resource.

Value "locations/external-service"
createdAtstringrequired

The date and time the tag was created.

updatedAtstringrequired

Date and time of the last update to the tag.

generationintegerrequired

Monotonically increasing update counter.

createTagsArray of objects(server.GetTags)

Location Tags to be created

deleteTagsArray of objects(server.GetTags)

Location Tags to be deleted

Response
application/json
{
  "createTags": [
    { … }
  ],
  "deleteTags": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "locations/external-service",
  "generation": 0,
  "createdAt": "string",
  "updatedAt": "string"
}

Retrieves tags for given a location

Request

Return a listing of all tag names and tag values for a given location. If a location has no tags, only the location ID and location name are returned.

Security
Bearer
Path
idstring(uuid)required

The unique identifier of the location. For example, 945e70ec-b043-4cad-9ed0-069c06fdb8af.

curl -i -X GET \
  'https://global.api.greenlake.hpe.com/locations/v1/locations/tags/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
locationIdstring(uuid)required

The unique identifier for the location.

locationNamestringrequired

The name of the location.

tagsArray of objects(server.GetTags)

An array of tag names and values. The array is empty if the location has no associated tags.

Response
application/json
{
  "tags": [
    { … }
  ],
  "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  "locationName": "string"
}

Retrieve location from latitude and longitude.

Request

Geolocate a location by providing the longitude and latitude. Optionally, provide an ISO language code to return the information in a language different from the default (English).

Security
Bearer
Query
latitudestringrequired

Provide a latitude coordinate.

longitudestringrequired

Provide a longitude coordinate.

languagestring

(Optional) Specify a language code to return the location information in that language. The default is English.

Examples:

Return the location description in Simplified Chinese.

language=zh-CN
curl -i -X GET \
  'https://global.api.greenlake.hpe.com/locations/v1/locations/address/revgeocode?latitude=string&longitude=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
labelstring

Full address label.

countryCodestring

ISO country code.

countryNamestring

Country name.

stateCodestring

State or province code.

statestring

State or province name.

countystring

County name.

citystring

City name.

streetstring

Street address.

postalCodestring

Postal or ZIP code.

latnumber(double)

Latitude coordinate.

lngnumber(double)

Longitude coordinate.

Response
application/json
{
  "label": "string",
  "countryCode": "string",
  "countryName": "string",
  "stateCode": "string",
  "state": "string",
  "county": "string",
  "city": "string",
  "street": "string",
  "postalCode": "string",
  "lat": 0.1,
  "lng": 0.1
}

Create locations using CSV file

Request

Create locations using a CSV file and store the associated information.

Security
Bearer
Bodymultipart/form-dataArray [
Location Name(Required)stringrequired

The name of the location to be created.

Street Address(Required)stringrequired

The street address of the location to be created.

City(Required)stringrequired

The city of the location to be created.

State/Province(Required)stringrequired

The state of the location to be created.

Country(Required)stringrequired

The country of the location to be created.

Zip/Postal Code(Required)stringrequired

The postal code of the location to be created.

Primary Contact Email(Required)stringrequired

The email of the primary contact.

First Name(Required)string

First name of the primary contact. Required only when the email provided is a NON GLP email.

Last Name(Required)string

Last name of the primary contact. Required only when the email provided is a NON GLP email.

Phone Number(Optional)string

The phone number of the primary contact, [+][country code][phone number] format (e.g., +14155552671), without spaces or separators.

Phone Extension(Optional)string

The phone extension of the primary contact, 1 to 4 digits (0-9). Required only when the Phone Number is provided.

Tag 1 Name (optional)string

Tag name associated with the location.

Tag 1 Value (optional)string

Tag value for the tag name associated with the location.

]
curl -i -X POST \
  'https://global.api.greenlake.hpe.com/locations/v1/locations/locations-csv-upload' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -F 'file=@file.csv'

Responses

OK

Bodyapplication/json
idstringrequired

CSV upload operation generated ID.

resultobject(server.CreateListLocationResponse)required
result.​totalCountinteger
result.​succeededCountinteger

Number of locations created successfully.

result.​failedCountinteger

The number of failed location creations.

result.​failedRecordsArray of objects(server.FailedCreateRecord)
result.​succeededRecordsArray of objects(server.SuccessCreateRecord)
result.​errorMessagestring
typestringrequired

The type of the resource.

Value "locations/asyncOperation"
statusstring
Enum"INITIALIZED""IN_PROGRESS""SUCCEEDED"
startedAtstring

The date and time the CSV upload operation started.

endedAtstring

The date and time the CSV upload operation ended.

progressPercentinteger

Progress percentage of the CSV upload operation.

suggestedPollingIntervalSecondsinteger

The polling interval of the CSV upload operation.

timeoutMinutesinteger
Response
application/json
{
  "status": "INITIALIZED",
  "startedAt": "string",
  "endedAt": "string",
  "progressPercent": 0,
  "suggestedPollingIntervalSeconds": 0,
  "timeoutMinutes": 0,
  "result": {
    "totalCount": 0,
    "succeededCount": 0,
    "failedCount": 0,
    "failedRecords": [ … ],
    "succeededRecords": [ … ],
    "errorMessage": "string"
  },
  "id": "string",
  "type": "locations/asyncOperation"
}

Retrieve a CSV upload status

Request

Return status information for a CSV location upload by using the async location ID as a parameter.

Security
Bearer
Path
idstring(uuid)required

The unique identifier of the async operation location ID. For example, 945e70ec-b043-4cad-9ed0-069c06fdb8af.

curl -i -X GET \
  'https://global.api.greenlake.hpe.com/locations/v1/locations/async-operation/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstringrequired

CSV upload operation generated ID.

resultobject(server.CreateListLocationResponse)required
result.​totalCountinteger
result.​succeededCountinteger

Number of locations created successfully.

result.​failedCountinteger

The number of failed location creations.

result.​failedRecordsArray of objects(server.FailedCreateRecord)
result.​succeededRecordsArray of objects(server.SuccessCreateRecord)
result.​errorMessagestring
typestringrequired

The type of the resource.

Value "locations/asyncOperation"
statusstring
Enum"INITIALIZED""IN_PROGRESS""SUCCEEDED"
startedAtstring

The date and time the CSV upload operation started.

endedAtstring

The date and time the CSV upload operation ended.

progressPercentinteger

Progress percentage of the CSV upload operation.

suggestedPollingIntervalSecondsinteger

The polling interval of the CSV upload operation.

timeoutMinutesinteger
Response
application/json
{
  "status": "INITIALIZED",
  "startedAt": "string",
  "endedAt": "string",
  "progressPercent": 0,
  "suggestedPollingIntervalSeconds": 0,
  "timeoutMinutes": 0,
  "result": {
    "totalCount": 0,
    "succeededCount": 0,
    "failedCount": 0,
    "failedRecords": [ … ],
    "succeededRecords": [ … ],
    "errorMessage": "string"
  },
  "id": "string",
  "type": "locations/asyncOperation"
}

Locations Management service status

Request

Get Locations Management service status

Security
Bearer
curl -i -X GET \
  https://global.api.greenlake.hpe.com/locations/v1/locations/status \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body