Table Of Contents

Previous topic

PAServiceTemplate

Next topic

ResourceTypeManagement

Application Packaging Standard

Last updated 18-Mar-2019

PASubscription

This type represents a Operations Automation subscription.

Schema

The considered APS type (download) extends the Subscription APS type(s) and looks as follows:

{
  "name": "PASubscription",
  "id": "http://parallels.com/aps/types/pa/subscription/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/subscription/1.0"
  ],
  "relations": {
    "account": {
      "type": "http://aps-standard.org/types/core/account/1.0"
    },
    "websites": {
      "type": "http://parallels.com/aps/types/pa/website/1.0",
      "collection": true
    }
  },
  "properties": {
    "subscriptionId": {
      "type": "integer",
      "required": true,
      "final": true
    },
    "serviceTemplateId": {
      "type": "integer",
      "required": true
    },
    "activationStructure": {
      "type": "ActivationStructure"
    }
  },
  "operations": {
    "provisioningState": {
      "path": "/provisioningState",
      "verb": "GET",
      "response": {
        "type": "ProvisioningState"
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "restartProvisioning": {
      "path": "/restartProvisioning",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    },
    "hold": {
      "path": "/hold",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    },
    "release": {
      "path": "/release",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    },
    "applications": {
      "path": "/applications",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "errorResponse": {
        "type": "object"
      }
    }
  },
  "structures": {
    "ActivationStructure": {
      "type": "object",
      "properties": {
        "domainApsId": {
          "type": "string"
        },
        "subscriptionResourceLimits": {
          "type": "array",
          "items": {
            "type": "SubscriptionResourceLimit"
          }
        },
        "apsDefaults": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "SubscriptionResourceLimit": {
      "type": "object",
      "properties": {
        "resourceId": {
          "type": "integer",
          "required": true
        },
        "resourceLimit": {
          "type": "integer",
          "required": true
        }
      }
    },
    "ProvisioningState": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

Properties

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
activationStructure ActivationStructure Not Required   Subscription activation parameters
serviceTemplateId Integer Required   Service Template Id in OA
subscriptionId Integer Required Final   Subscription identifier in OA

Relationship

NAME TYPE REQUIRED DESCRIPTION
account Account No Account owns the subscription
websites Collection of paWebsite No Websites collection

Custom Operations

OPERATION VERB PATH RETURNS Description
applications GET /applications If successful, this method returns collection of application IDs in response body Get APS applications related to subscription
hold POST /hold   Put subscription on hold in BSS
provisioningState GET /provisioningState ProvisioningState Custom operation to check provisioning state of subscription
release POST /release   Release subscription from hold in BSS
restartProvisioning POST /restartProvisioning If successful, this method returns a 200 OK standard status code Custom operation for restarting subscription provisioning in case it’s failed

applications

HTTP Request

GET /aps/2/resources/{aps-id}/applications

Description

Get APS applications related to subscription

Returns

If successful, this method returns collection of application IDs in response body

hold

HTTP Request

POST /aps/2/resources/{aps-id}/hold

Description

Put subscription on hold in BSS

Returns

provisioningState

HTTP Request

GET /aps/2/resources/{aps-id}/provisioningState

Description

Custom operation to check provisioning state of subscription

Returns

ProvisioningState

release

HTTP Request

POST /aps/2/resources/{aps-id}/release

Description

Release subscription from hold in BSS

Returns

restartProvisioning

HTTP Request

POST /aps/2/resources/{aps-id}/restartProvisioning

Description

Custom operation for restarting subscription provisioning in case it’s failed

Returns

If successful, this method returns a 200 OK standard status code

Structures

ActivationStructure

Structure for activation parameters

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
apsDefaults String Not Required   APS defaults structure for activation subscription with provisioning parameters
domainApsId String Not Required   Domain aps id for binding services to domain
subscriptionResourceLimits SubscriptionResourceLimit Not Required   Limit of resources to provide

ProvisioningState

Current subscription provisioning state structure

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
message String Not Required   If provisioning is failed this field will contains error message
state String Not Required   Current provisioning state of the subscription

SubscriptionResourceLimit

Structure for resource limits

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
resourceId Integer Required   Internal resource id
resourceLimit Integer Required   Resource Limit

Examples

Please find general description of create-read-update-delete (CRUD) operations with resources, properties, and structures respectively at:

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.