Skip to content
Internal API Catalog
/
Service offer management
/
API reference
/
Service Provision

Service provision management (v1beta1)

The API reference documentation for endpoints related to service provision management.

Download OpenAPI description
service_provision_v1beta1_nbapi.json
service_provision_v1beta1_nbapi.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-provision-nbapi-v1beta1/service_provision_v1beta1_nbapi/

https://global.api.greenlake.hpe.com/

Service Provision

Operations

Get service provisions

Request

Retrieve a list of service provisions by applying filters. A service offer provides a distinct set of functionalities that can be independently identified and assigned access. Service offers are typically associated with roles and permissions, commerce, metering, quote-to-cash, and trial evaluations. A service provision occurs when a service offer is provisioned (added) to a workspace.

Pagination: This endpoint supports cursor-based pagination using the next query parameter. Provide the cursor in the next query parameter to retrieve the next page.

Security
bearerAuth
Query
nextstring(Pagination cursor)

Specify the start ID for the next page of service offers.

limitinteger(Pagination limit)[ 1 .. 2000 ]

Specify the number of results to be returned.

Default 2000
filterstring

Limit the entities operated on by this endpoint by returning only the subset of entities that match the filter. The filter grammar is a subset of OData 4.0.
Supported Fields: id, ServiceOfferId, workspaceId, serviceManagerProvisionId, serviceManagerId, serviceManagerInstanceId, status, organizationId, slug.
Supported operand: eq
Supported operations: and

Examples:

Return the service provision with a given ID.

Return service provisions for a given workspace ID.

Return service provisions for a given Application Customer ID.

Return service provisions for a given service offer ID and region.

Return service provision for a given application ID and application instance ID.

Return service provisions with a given status.

Return service provisions with a given organization ID.

Return service provisions with a given slug.

unredactedboolean(unredacted)

If true, returns the complete entry including sensitive fields.

Default false
Example: unredacted=true
allboolean(all)

If true, returns unredacted entries for all workspaces, including all provisioned service offers and their sensitive fields.

Default false
Example: all=true
Headers
Hpe-workspace-idstring(uuid)(Workspace ID)

The workspace ID. Required if the "view all" parameter is false.

Default Id
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-provision-nbapi-v1beta1/service_provision_v1beta1_nbapi/service-catalog/v1beta1/service-provisions \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
itemsArray of objects(Service provision list)required
items[].​idstring(uuid)(Id)required

The unique service provision identifier.

Example: "2fa85f64-5717-4562-b3fc-2c963f66afa9"
items[].​resourceUristring(ResourceUri)required

The URI of the resource.

Example: "/service-catalog/{version}/service-provisions/2fa85f64-5717-4562-b3fc-2c963f66afa9"
items[].​serviceOfferobject(ServiceOfferResourceLink)required

Information about the associated service offer.

items[].​serviceOffer.​idstring(uuid)(ServiceOfferId)

The unique identifier of a service offer.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
items[].​serviceOffer.​namestring(Name)

The name of the service offer

Example: "Aruba Central"
items[].​serviceOffer.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/service-catalog/v1alpha1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
items[].​regionstring(Region)required

The HPE GreenLake-defined region code.

Example: "us-west"
items[].​workspaceobject(WorkspaceResourceLink)required

Information about the associated workspace. In HPE GreenLake, a workspace is a secure, dedicated environment for managing resources.

items[].​workspace.​idstring(uuid)(WorkspaceId)

The workspace ID.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
items[].​workspace.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/workspaces/v1/workspaces/{workspaceId}"
items[].​workspace.​namestring(Workspace name)

The workspace name.

Example: "Hewlett Packard Enterprise"
items[].​workspace.​organizationIdstring(uuid)(OrganizationId)

The organization ID. Each HPE GreenLake Organization operates as a distinct tenant with its own identity directory and unique organization ID.

Example: "5ab85f64-6717-5562-c3fc-3c963f66afa6"
items[].​workspace.​workspaceTransferStatusstring(WorkspaceTransferStatus)

The status of a workspace transfer from one type to another.

Enum"TRANSFER_INITIATED""TRANSFER_COMPLETED""TRANSFER_FAILED"
items[].​workspace.​mspIdstring(MspId)

The unique identifier of an MSP tenant account.

Example: "3ca24f18-5013-4562-b3fc-2d992f22ade2"
items[].​retryCountinteger(RetryCount)required

The number of times the operation has been retried.

Example: 0
items[].​typestring(ResourceType)required

The type of the resource.

Example: "/service-catalog/service-provision"
items[].​createdAtstring(date-time)(CreatedAt)required

Date and time at which the service offer was created.

Example: "2021-04-23T10:20:30.400+02:30"
items[].​updatedAtstring(date-time)(UpdatedAt)required

Date and time at which the service offer was updated.

Example: "2021-04-29T10:20:30.400+02:30"
items[].​generationinteger(Generation)required

A monotonically increasing update counter.

Example: 1
items[].​serviceManagerobject(ServiceManagerResourceLink)

Information about the associated service manager, including its ID and resource URI.

items[].​serviceManagerProvisionobject(ServiceManagerProvisionResourceLink)

Details of the provisioned service manager, including its ID, resource URI, account type, operational mode, provision status, and MSP conversion status.

items[].​serviceManagerInstanceIdany(ServiceManagerInstanceId)

The unique identifier of a service manager instance. This is the application instance ID of an application related to a service offer.

Example: "2fc85f64-5717-4562-b3fc-2c963f66afa3"
items[].​provisionStatusstring(ProvisionStatus)

The provisioning status of the service in the workspace.

Enum"PROVISION_INITIATED""PROVISIONED""PROVISION_FAILED"
items[].​reasonstring(Reason)

The reason the service provision creation failed.

Example: "Failed to configure IDP."
items[].​createdBystring(CreatedBy)

The email address of the user who created the service provision.

Example: "user@company.com"
countinteger(Count per page)required

The number of items returned.

Default 1
nextstring(Next)required

Cursor for the next page of resources.

Example: "64136af7-cd64-4b4e-88a8-150ab51a920d"
totalinteger(Total count)required

Total number of items in the result set.

Default 10
Response
application/json
{
  "items": [
    { … }
  ],
  "next": "64136af7-cd64-4b4e-88a8-150ab51a920d",
  "count": 1,
  "total": 10
}

Create a service provision

Request

The initial step to provision a service offer in a region. A service offer provides a distinct set of functionalities that can be independently identified and assigned access. Service offers are typically associated with roles and permissions, commerce, metering, quote-to-cash, and trial evaluations.

You need to supply the following in the request body.

  • serviceOfferId-From Service offer management use the Get service offers endpoint to find service offer IDs.
  • region-From Service offer management use the Get service offer regions endpoint to find region codes.

Security
bearerAuth
Bodyapplication/jsonrequired
serviceOfferIdstring(uuid)(ServiceOfferId)required

The unique identifier for the service offer.

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
regionstring(RegionCode)required

The HPE GreenLake-defined region code.

Example: "us-west"
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-provision-nbapi-v1beta1/service_provision_v1beta1_nbapi/service-catalog/v1beta1/service-provisions \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "serviceOfferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "region": "us-west"
  }'

Responses

201 ServiceProvision Created Response

Headers
Locationstring

URL of the created workspace.

Bodyapplication/json
idstring(uuid)(Id)required

The unique service provision identifier.

Example: "2fa85f64-5717-4562-b3fc-2c963f66afa9"
resourceUristring(ResourceUri)required

The URI of the resource.

Example: "/service-catalog/{version}/service-provisions/2fa85f64-5717-4562-b3fc-2c963f66afa9"
serviceOfferobject(ServiceOfferResourceLink)required

Information about the associated service offer.

serviceOffer.​idstring(uuid)(ServiceOfferId)

The unique identifier of a service offer.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
serviceOffer.​namestring(Name)

The name of the service offer

Example: "Aruba Central"
serviceOffer.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/service-catalog/v1alpha1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
regionstring(Region)required

The HPE GreenLake-defined region code.

Example: "us-west"
workspaceobject(WorkspaceResourceLink)required

Information about the associated workspace. In HPE GreenLake, a workspace is a secure, dedicated environment for managing resources.

workspace.​idstring(uuid)(WorkspaceId)

The workspace ID.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
workspace.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/workspaces/v1/workspaces/{workspaceId}"
workspace.​namestring(Workspace name)

The workspace name.

Example: "Hewlett Packard Enterprise"
workspace.​organizationIdstring(uuid)(OrganizationId)

The organization ID. Each HPE GreenLake Organization operates as a distinct tenant with its own identity directory and unique organization ID.

Example: "5ab85f64-6717-5562-c3fc-3c963f66afa6"
workspace.​workspaceTransferStatusstring(WorkspaceTransferStatus)

The status of a workspace transfer from one type to another.

Enum"TRANSFER_INITIATED""TRANSFER_COMPLETED""TRANSFER_FAILED"
workspace.​mspIdstring(MspId)

The unique identifier of an MSP tenant account.

Example: "3ca24f18-5013-4562-b3fc-2d992f22ade2"
retryCountinteger(RetryCount)required

The number of times the operation has been retried.

Example: 0
typestring(ResourceType)required

The type of the resource.

Example: "/service-catalog/service-provision"
createdAtstring(date-time)(CreatedAt)required

Date and time at which the service offer was created.

Example: "2021-04-23T10:20:30.400+02:30"
updatedAtstring(date-time)(UpdatedAt)required

Date and time at which the service offer was updated.

Example: "2021-04-29T10:20:30.400+02:30"
generationinteger(Generation)required

A monotonically increasing update counter.

Example: 1
serviceManagerobject(ServiceManagerResourceLink)

Information about the associated service manager, including its ID and resource URI.

serviceManagerProvisionobject(ServiceManagerProvisionResourceLink)

Details of the provisioned service manager, including its ID, resource URI, account type, operational mode, provision status, and MSP conversion status.

serviceManagerInstanceIdany(ServiceManagerInstanceId)

The unique identifier of a service manager instance. This is the application instance ID of an application related to a service offer.

Example: "2fc85f64-5717-4562-b3fc-2c963f66afa3"
provisionStatusstring(ProvisionStatus)

The provisioning status of the service in the workspace.

Enum"PROVISION_INITIATED""PROVISIONED""PROVISION_FAILED"
reasonstring(Reason)

The reason the service provision creation failed.

Example: "Failed to configure IDP."
createdBystring(CreatedBy)

The email address of the user who created the service provision.

Example: "user@company.com"
Response
application/json
{
  "id": "2fa85f64-5717-4562-b3fc-2c963f66afa9",
  "resourceUri": "/service-catalog/{version}/service-provisions/2fa85f64-5717-4562-b3fc-2c963f66afa9",
  "serviceOffer": {
    "id": "4ab85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Aruba Central",
    "resourceUri": "/service-catalog/v1alpha1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "region": "us-west",
  "serviceManager": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "resourceUri": "/service-catalog/v1beta1/service-managers/3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "serviceManagerProvision": {
    "id": "2fb85f64-5717-4562-b3fc-2c963f66afa2",
    "resourceUri": "/service-catalog/v1beta1/service-manager-provisions/2fb85f64-5717-4562-b3fc-2c963f66afa2",
    "accountType": "BASIC_ORGANIZATION",
    "operationalMode": "DEFAULT",
    "provisionStatus": "PROVISION_INITIATED",
    "mspConversionStatus": "MSP_CONVERSION_INITIATED"
  },
  "workspace": {
    "id": "4ab85f64-5717-4562-b3fc-2c963f66afa6",
    "resourceUri": "/workspaces/v1/workspaces/{workspaceId}",
    "name": "Hewlett Packard Enterprise",
    "organizationId": "5ab85f64-6717-5562-c3fc-3c963f66afa6",
    "workspaceTransferStatus": "TRANSFER_INITIATED",
    "mspId": "3ca24f18-5013-4562-b3fc-2d992f22ade2"
  },
  "serviceManagerInstanceId": "2fc85f64-5717-4562-b3fc-2c963f66afa3",
  "provisionStatus": "PROVISION_INITIATED",
  "reason": "Failed to configure IDP.",
  "retryCount": 0,
  "createdBy": "user@company.com",
  "createdAt": "2021-04-23T10:20:30.400+02:30",
  "updatedAt": "2021-04-29T10:20:30.400+02:30",
  "generation": 1,
  "type": "/service-catalog/service-provision"
}

Get service provision

Request

Fetch service provision details for an ID.

Security
bearerAuth
Path
idstring(uuid)(Id)required

The unique identifier of a service provision. The ID is returned by the Get service provisions endpoint.

Query
unredactedboolean(unredacted)

If set to true, get the entire entry along with sensitive fields.

Default false
Example: unredacted=true
curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-provision-nbapi-v1beta1/service_provision_v1beta1_nbapi/service-catalog/v1beta1/service-provisions/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required

The unique service provision identifier.

Example: "2fa85f64-5717-4562-b3fc-2c963f66afa9"
resourceUristring(ResourceUri)required

The URI of the resource.

Example: "/service-catalog/{version}/service-provisions/2fa85f64-5717-4562-b3fc-2c963f66afa9"
serviceOfferobject(ServiceOfferResourceLink)required

Information about the associated service offer.

serviceOffer.​idstring(uuid)(ServiceOfferId)

The unique identifier of a service offer.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
serviceOffer.​namestring(Name)

The name of the service offer

Example: "Aruba Central"
serviceOffer.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/service-catalog/v1alpha1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
regionstring(Region)required

The HPE GreenLake-defined region code.

Example: "us-west"
workspaceobject(WorkspaceResourceLink)required

Information about the associated workspace. In HPE GreenLake, a workspace is a secure, dedicated environment for managing resources.

workspace.​idstring(uuid)(WorkspaceId)

The workspace ID.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
workspace.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/workspaces/v1/workspaces/{workspaceId}"
workspace.​namestring(Workspace name)

The workspace name.

Example: "Hewlett Packard Enterprise"
workspace.​organizationIdstring(uuid)(OrganizationId)

The organization ID. Each HPE GreenLake Organization operates as a distinct tenant with its own identity directory and unique organization ID.

Example: "5ab85f64-6717-5562-c3fc-3c963f66afa6"
workspace.​workspaceTransferStatusstring(WorkspaceTransferStatus)

The status of a workspace transfer from one type to another.

Enum"TRANSFER_INITIATED""TRANSFER_COMPLETED""TRANSFER_FAILED"
workspace.​mspIdstring(MspId)

The unique identifier of an MSP tenant account.

Example: "3ca24f18-5013-4562-b3fc-2d992f22ade2"
retryCountinteger(RetryCount)required

The number of times the operation has been retried.

Example: 0
typestring(ResourceType)required

The type of the resource.

Example: "/service-catalog/service-provision"
createdAtstring(date-time)(CreatedAt)required

Date and time at which the service offer was created.

Example: "2021-04-23T10:20:30.400+02:30"
updatedAtstring(date-time)(UpdatedAt)required

Date and time at which the service offer was updated.

Example: "2021-04-29T10:20:30.400+02:30"
generationinteger(Generation)required

A monotonically increasing update counter.

Example: 1
serviceManagerobject(ServiceManagerResourceLink)

Information about the associated service manager, including its ID and resource URI.

serviceManagerProvisionobject(ServiceManagerProvisionResourceLink)

Details of the provisioned service manager, including its ID, resource URI, account type, operational mode, provision status, and MSP conversion status.

serviceManagerInstanceIdany(ServiceManagerInstanceId)

The unique identifier of a service manager instance. This is the application instance ID of an application related to a service offer.

Example: "2fc85f64-5717-4562-b3fc-2c963f66afa3"
provisionStatusstring(ProvisionStatus)

The provisioning status of the service in the workspace.

Enum"PROVISION_INITIATED""PROVISIONED""PROVISION_FAILED"
reasonstring(Reason)

The reason the service provision creation failed.

Example: "Failed to configure IDP."
createdBystring(CreatedBy)

The email address of the user who created the service provision.

Example: "user@company.com"
Response
application/json
{
  "id": "2fa85f64-5717-4562-b3fc-2c963f66afa9",
  "resourceUri": "/service-catalog/{version}/service-provisions/2fa85f64-5717-4562-b3fc-2c963f66afa9",
  "serviceOffer": {
    "id": "4ab85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Aruba Central",
    "resourceUri": "/service-catalog/v1alpha1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "region": "us-west",
  "serviceManager": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "resourceUri": "/service-catalog/v1beta1/service-managers/3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "serviceManagerProvision": {
    "id": "2fb85f64-5717-4562-b3fc-2c963f66afa2",
    "resourceUri": "/service-catalog/v1beta1/service-manager-provisions/2fb85f64-5717-4562-b3fc-2c963f66afa2",
    "accountType": "BASIC_ORGANIZATION",
    "operationalMode": "DEFAULT",
    "provisionStatus": "PROVISION_INITIATED",
    "mspConversionStatus": "MSP_CONVERSION_INITIATED"
  },
  "workspace": {
    "id": "4ab85f64-5717-4562-b3fc-2c963f66afa6",
    "resourceUri": "/workspaces/v1/workspaces/{workspaceId}",
    "name": "Hewlett Packard Enterprise",
    "organizationId": "5ab85f64-6717-5562-c3fc-3c963f66afa6",
    "workspaceTransferStatus": "TRANSFER_INITIATED",
    "mspId": "3ca24f18-5013-4562-b3fc-2d992f22ade2"
  },
  "serviceManagerInstanceId": "2fc85f64-5717-4562-b3fc-2c963f66afa3",
  "provisionStatus": "PROVISION_INITIATED",
  "reason": "Failed to configure IDP.",
  "retryCount": 0,
  "createdBy": "user@company.com",
  "createdAt": "2021-04-23T10:20:30.400+02:30",
  "updatedAt": "2021-04-29T10:20:30.400+02:30",
  "generation": 1,
  "type": "/service-catalog/service-provision"
}

Delete a service provision

Request

Delete a specific service provision.

Security
bearerAuth
Path
idstring(uuid)(Id)required

The unique identifier of a service offer. The ID is returned by the Get service provisions endpoint.

Query
forceboolean(Force-flag)

Specifies the force-delete action, regardless of the provision status.

Default false
Example: force=true
Headers
If-Matchinteger(If-Match)required

Generation version match. To avoid unintended deletions, the generation version must match. This value is incremented whenever the record is updated.

Example: 1
curl -i -X DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-provision-nbapi-v1beta1/service_provision_v1beta1_nbapi/service-catalog/v1beta1/service-provisions/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'If-Match: 1'

Responses

NoContent

Response
No content

Retrigger service provisioning

Request

Retrigger service provisioning if it has failed.

Security
bearerAuth
Path
idstring(uuid)(Id)required

The unique identifier for the service provision. The ID is returned by the Get service provisions endpoint.

curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-provision-nbapi-v1beta1/service_provision_v1beta1_nbapi/service-catalog/v1beta1/service-provisions/{id}/retry' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

201 ServiceProvision Created Response

Headers
Locationstring

URL of the created workspace.

Bodyapplication/json
idstring(uuid)(Id)required

The unique service provision identifier.

Example: "2fa85f64-5717-4562-b3fc-2c963f66afa9"
resourceUristring(ResourceUri)required

The URI of the resource.

Example: "/service-catalog/{version}/service-provisions/2fa85f64-5717-4562-b3fc-2c963f66afa9"
serviceOfferobject(ServiceOfferResourceLink)required

Information about the associated service offer.

serviceOffer.​idstring(uuid)(ServiceOfferId)

The unique identifier of a service offer.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
serviceOffer.​namestring(Name)

The name of the service offer

Example: "Aruba Central"
serviceOffer.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/service-catalog/v1alpha1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
regionstring(Region)required

The HPE GreenLake-defined region code.

Example: "us-west"
workspaceobject(WorkspaceResourceLink)required

Information about the associated workspace. In HPE GreenLake, a workspace is a secure, dedicated environment for managing resources.

workspace.​idstring(uuid)(WorkspaceId)

The workspace ID.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
workspace.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/workspaces/v1/workspaces/{workspaceId}"
workspace.​namestring(Workspace name)

The workspace name.

Example: "Hewlett Packard Enterprise"
workspace.​organizationIdstring(uuid)(OrganizationId)

The organization ID. Each HPE GreenLake Organization operates as a distinct tenant with its own identity directory and unique organization ID.

Example: "5ab85f64-6717-5562-c3fc-3c963f66afa6"
workspace.​workspaceTransferStatusstring(WorkspaceTransferStatus)

The status of a workspace transfer from one type to another.

Enum"TRANSFER_INITIATED""TRANSFER_COMPLETED""TRANSFER_FAILED"
workspace.​mspIdstring(MspId)

The unique identifier of an MSP tenant account.

Example: "3ca24f18-5013-4562-b3fc-2d992f22ade2"
retryCountinteger(RetryCount)required

The number of times the operation has been retried.

Example: 0
typestring(ResourceType)required

The type of the resource.

Example: "/service-catalog/service-provision"
createdAtstring(date-time)(CreatedAt)required

Date and time at which the service offer was created.

Example: "2021-04-23T10:20:30.400+02:30"
updatedAtstring(date-time)(UpdatedAt)required

Date and time at which the service offer was updated.

Example: "2021-04-29T10:20:30.400+02:30"
generationinteger(Generation)required

A monotonically increasing update counter.

Example: 1
serviceManagerobject(ServiceManagerResourceLink)

Information about the associated service manager, including its ID and resource URI.

serviceManagerProvisionobject(ServiceManagerProvisionResourceLink)

Details of the provisioned service manager, including its ID, resource URI, account type, operational mode, provision status, and MSP conversion status.

serviceManagerInstanceIdany(ServiceManagerInstanceId)

The unique identifier of a service manager instance. This is the application instance ID of an application related to a service offer.

Example: "2fc85f64-5717-4562-b3fc-2c963f66afa3"
provisionStatusstring(ProvisionStatus)

The provisioning status of the service in the workspace.

Enum"PROVISION_INITIATED""PROVISIONED""PROVISION_FAILED"
reasonstring(Reason)

The reason the service provision creation failed.

Example: "Failed to configure IDP."
createdBystring(CreatedBy)

The email address of the user who created the service provision.

Example: "user@company.com"
Response
application/json
{
  "id": "2fa85f64-5717-4562-b3fc-2c963f66afa9",
  "resourceUri": "/service-catalog/{version}/service-provisions/2fa85f64-5717-4562-b3fc-2c963f66afa9",
  "serviceOffer": {
    "id": "4ab85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Aruba Central",
    "resourceUri": "/service-catalog/v1alpha1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "region": "us-west",
  "serviceManager": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "resourceUri": "/service-catalog/v1beta1/service-managers/3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "serviceManagerProvision": {
    "id": "2fb85f64-5717-4562-b3fc-2c963f66afa2",
    "resourceUri": "/service-catalog/v1beta1/service-manager-provisions/2fb85f64-5717-4562-b3fc-2c963f66afa2",
    "accountType": "BASIC_ORGANIZATION",
    "operationalMode": "DEFAULT",
    "provisionStatus": "PROVISION_INITIATED",
    "mspConversionStatus": "MSP_CONVERSION_INITIATED"
  },
  "workspace": {
    "id": "4ab85f64-5717-4562-b3fc-2c963f66afa6",
    "resourceUri": "/workspaces/v1/workspaces/{workspaceId}",
    "name": "Hewlett Packard Enterprise",
    "organizationId": "5ab85f64-6717-5562-c3fc-3c963f66afa6",
    "workspaceTransferStatus": "TRANSFER_INITIATED",
    "mspId": "3ca24f18-5013-4562-b3fc-2d992f22ade2"
  },
  "serviceManagerInstanceId": "2fc85f64-5717-4562-b3fc-2c963f66afa3",
  "provisionStatus": "PROVISION_INITIATED",
  "reason": "Failed to configure IDP.",
  "retryCount": 0,
  "createdBy": "user@company.com",
  "createdAt": "2021-04-23T10:20:30.400+02:30",
  "updatedAt": "2021-04-29T10:20:30.400+02:30",
  "generation": 1,
  "type": "/service-catalog/service-provision"
}

Retrigger service deletion

Request

Retrigger service deletion in case it failed.

Security
bearerAuth
Path
idstring(uuid)(Id)required

The unique identifier for the service provision. The ID is returned by the Get service provisions endpoint.

curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/service-catalog/public/openapi/service-provision-nbapi-v1beta1/service_provision_v1beta1_nbapi/service-catalog/v1beta1/service-provisions/{id}/retry-unprovision' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

201 ServiceProvision Created Response

Headers
Locationstring

URL of the created workspace.

Bodyapplication/json
idstring(uuid)(Id)required

The unique service provision identifier.

Example: "2fa85f64-5717-4562-b3fc-2c963f66afa9"
resourceUristring(ResourceUri)required

The URI of the resource.

Example: "/service-catalog/{version}/service-provisions/2fa85f64-5717-4562-b3fc-2c963f66afa9"
serviceOfferobject(ServiceOfferResourceLink)required

Information about the associated service offer.

serviceOffer.​idstring(uuid)(ServiceOfferId)

The unique identifier of a service offer.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
serviceOffer.​namestring(Name)

The name of the service offer

Example: "Aruba Central"
serviceOffer.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/service-catalog/v1alpha1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
regionstring(Region)required

The HPE GreenLake-defined region code.

Example: "us-west"
workspaceobject(WorkspaceResourceLink)required

Information about the associated workspace. In HPE GreenLake, a workspace is a secure, dedicated environment for managing resources.

workspace.​idstring(uuid)(WorkspaceId)

The workspace ID.

Example: "4ab85f64-5717-4562-b3fc-2c963f66afa6"
workspace.​resourceUristring(Resource URI)

The URI of the resource.

Example: "/workspaces/v1/workspaces/{workspaceId}"
workspace.​namestring(Workspace name)

The workspace name.

Example: "Hewlett Packard Enterprise"
workspace.​organizationIdstring(uuid)(OrganizationId)

The organization ID. Each HPE GreenLake Organization operates as a distinct tenant with its own identity directory and unique organization ID.

Example: "5ab85f64-6717-5562-c3fc-3c963f66afa6"
workspace.​workspaceTransferStatusstring(WorkspaceTransferStatus)

The status of a workspace transfer from one type to another.

Enum"TRANSFER_INITIATED""TRANSFER_COMPLETED""TRANSFER_FAILED"
workspace.​mspIdstring(MspId)

The unique identifier of an MSP tenant account.

Example: "3ca24f18-5013-4562-b3fc-2d992f22ade2"
retryCountinteger(RetryCount)required

The number of times the operation has been retried.

Example: 0
typestring(ResourceType)required

The type of the resource.

Example: "/service-catalog/service-provision"
createdAtstring(date-time)(CreatedAt)required

Date and time at which the service offer was created.

Example: "2021-04-23T10:20:30.400+02:30"
updatedAtstring(date-time)(UpdatedAt)required

Date and time at which the service offer was updated.

Example: "2021-04-29T10:20:30.400+02:30"
generationinteger(Generation)required

A monotonically increasing update counter.

Example: 1
serviceManagerobject(ServiceManagerResourceLink)

Information about the associated service manager, including its ID and resource URI.

serviceManagerProvisionobject(ServiceManagerProvisionResourceLink)

Details of the provisioned service manager, including its ID, resource URI, account type, operational mode, provision status, and MSP conversion status.

serviceManagerInstanceIdany(ServiceManagerInstanceId)

The unique identifier of a service manager instance. This is the application instance ID of an application related to a service offer.

Example: "2fc85f64-5717-4562-b3fc-2c963f66afa3"
provisionStatusstring(ProvisionStatus)

The provisioning status of the service in the workspace.

Enum"PROVISION_INITIATED""PROVISIONED""PROVISION_FAILED"
reasonstring(Reason)

The reason the service provision creation failed.

Example: "Failed to configure IDP."
createdBystring(CreatedBy)

The email address of the user who created the service provision.

Example: "user@company.com"
Response
application/json
{
  "id": "2fa85f64-5717-4562-b3fc-2c963f66afa9",
  "resourceUri": "/service-catalog/{version}/service-provisions/2fa85f64-5717-4562-b3fc-2c963f66afa9",
  "serviceOffer": {
    "id": "4ab85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Aruba Central",
    "resourceUri": "/service-catalog/v1alpha1/service-offers/4ab85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "region": "us-west",
  "serviceManager": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "resourceUri": "/service-catalog/v1beta1/service-managers/3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "serviceManagerProvision": {
    "id": "2fb85f64-5717-4562-b3fc-2c963f66afa2",
    "resourceUri": "/service-catalog/v1beta1/service-manager-provisions/2fb85f64-5717-4562-b3fc-2c963f66afa2",
    "accountType": "BASIC_ORGANIZATION",
    "operationalMode": "DEFAULT",
    "provisionStatus": "PROVISION_INITIATED",
    "mspConversionStatus": "MSP_CONVERSION_INITIATED"
  },
  "workspace": {
    "id": "4ab85f64-5717-4562-b3fc-2c963f66afa6",
    "resourceUri": "/workspaces/v1/workspaces/{workspaceId}",
    "name": "Hewlett Packard Enterprise",
    "organizationId": "5ab85f64-6717-5562-c3fc-3c963f66afa6",
    "workspaceTransferStatus": "TRANSFER_INITIATED",
    "mspId": "3ca24f18-5013-4562-b3fc-2d992f22ade2"
  },
  "serviceManagerInstanceId": "2fc85f64-5717-4562-b3fc-2c963f66afa3",
  "provisionStatus": "PROVISION_INITIATED",
  "reason": "Failed to configure IDP.",
  "retryCount": 0,
  "createdBy": "user@company.com",
  "createdAt": "2021-04-23T10:20:30.400+02:30",
  "updatedAt": "2021-04-29T10:20:30.400+02:30",
  "generation": 1,
  "type": "/service-catalog/service-provision"
}