BundleTenant

Schema

The considered APS type (download) extends the subscriptionService, Suspendable APS type(s) and looks as follows:

{
  "name": "BundleTenant",
  "id": "http://aps-standard.org/inhouse-products/bundle-tenant/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/subscription/service/1.0",
    "http://aps-standard.org/types/core/suspendable/1.0"
  ],
  "relations": {
    "account": {
      "type": "http://parallels.com/aps/types/pa/account/1.2",
      "required": true
    },
    "subscription": {
      "type": "http://aps-standard.org/types/core/subscription/1.0",
      "required": true
    },
    "resellerProfile": {
      "type": "resellerProfile",
      "required": true
    },
    "tenants": {
      "type": "http://aps-standard.org/inhouse-products/tenant/1.1",
      "collection": true
    },
    "productLines": {
      "type": "http://com.odin.platform/inhouse-products/productLine/1.0",
      "collection": true
    },
    "bundleProductLine": {
      "type": "http://com.odin.platform/inhouse-products/bundleProductLine/1.0",
      "required": true
    }
  },
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "PENDING_FULFILLMENT",
        "PROCESSING",
        "ACTIVE",
        "FAILED"
      ]
    },
    "activationParameters": {
      "type": "array",
      "title": "Product line specific activation parameters",
      "items": {
        "type": "BundleTenantActivationParameter"
      }
    }
  },
  "operations": {
    "onLimitChange": {
      "path": "onLimitChange",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "subscriptionEvent": {
          "kind": "body",
          "type": "http://aps-standard.org/types/core/resource/1.0#Notification",
          "required": true
        }
      },
      "eventSubscription": {
        "event": "http://parallels.com/aps/events/pa/subscription/limits/changed",
        "source": {
          "type": "http://parallels.com/aps/types/pa/subscription/1.0"
        }
      }
    },
    "onSubscriptionRenewal": {
      "path": "onSubscriptionRenewal",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "subscriptionEvent": {
          "kind": "body",
          "type": "http://aps-standard.org/types/core/resource/1.0#Notification",
          "required": true
        }
      },
      "eventSubscription": {
        "event": "http://parallels.com/aps/events/pa/subscription/renewed",
        "source": {
          "type": "http://parallels.com/aps/types/pa/subscription/1.0"
        }
      }
    },
    "onActivateScheduledChanges": {
      "path": "onActivateScheduledChanges",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "subscriptionEvent": {
          "kind": "body",
          "type": "http://aps-standard.org/types/core/resource/1.0#Notification",
          "required": true
        }
      },
      "eventSubscription": {
        "event": "http://parallels.com/aps/events/pa/subscription/activate/changes",
        "source": {
          "type": "http://parallels.com/aps/types/pa/subscription/1.0"
        }
      }
    },
    "onCancelScheduledChanges": {
      "path": "onCancelScheduledChanges",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "subscriptionEvent": {
          "kind": "body",
          "type": "http://aps-standard.org/types/core/resource/1.0#Notification",
          "required": true
        }
      },
      "eventSubscription": {
        "event": "http://parallels.com/aps/events/pa/subscription/cancel/changes",
        "source": {
          "type": "http://parallels.com/aps/types/pa/subscription/1.0"
        }
      }
    }
  },
  "structures": {
    "BundleTenantActivationParameter": {
      "type": "object",
      "properties": {
        "productLineUid": {
          "type": "string",
          "title": "Product line UID"
        }
      }
    },
    "SubscriptionSource": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "SubscriptionEvent": {
      "type": "object",
      "properties": {
        "event": {
          "type": "string"
        },
        "subscription": {
          "type": "string"
        },
        "source": {
          "type": "SubscriptionSource"
        }
      }
    }
  }
}

Properties

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
status	Enum	Not Required
activationParameters	Array of BundleTenantActivationParameter	Not Required

Relationship

NAME	TYPE	REQUIRED	DESCRIPTION
account	PAAccount	Yes
subscription	Subscription	Yes
resellerProfile	resellerProfile	Yes
tenants	Collection of Tenant	No
productLines	Collection of ProductLine	No
bundleProductLine	BundleProductLine	Yes

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
onLimitChange	POST	/onLimitChange
onSubscriptionRenewal	POST	/onSubscriptionRenewal
onActivateScheduledChanges	POST	/onActivateScheduledChanges
onCancelScheduledChanges	POST	/onCancelScheduledChanges

onLimitChange

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
subscriptionEvent	Http://aps-standard.org/types/core/resource/1.0#Notification

Returns

onSubscriptionRenewal

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
subscriptionEvent	Http://aps-standard.org/types/core/resource/1.0#Notification

Returns

onActivateScheduledChanges

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
subscriptionEvent	Http://aps-standard.org/types/core/resource/1.0#Notification

Returns

onCancelScheduledChanges

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
subscriptionEvent	Http://aps-standard.org/types/core/resource/1.0#Notification

Returns

Structures

BundleTenantActivationParameter

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
productLineUid	String	Not Required

SubscriptionSource

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
id	String	Not Required
type	String	Not Required

SubscriptionEvent

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
event	String	Not Required
subscription	String	Not Required
source	SubscriptionSource	Not Required

Examples

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

• Provisioning Resources

• Getting a Resource List

• Resource Configuration

• Unprovisioning Resources

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

← BundleProductLine

BundlesManagementCBStore →