APS Types

This reference guide provides the full information about APS types that allow using the built-in platform services and build a resource model of an APS application.

In this document:

Overview

The guide contains the following groups of documents:

  • Type Definition discloses the APS type structure and provides detailed data about all components, including general data, implementation of other types, properties, composite structures, operations, and privileges. It is necessary to know that information to build custom APS types implementing Abstract Types and integrating APS application with the platform through the Platform Types.

  • Abstract Types contains reference data for every base APS type to be implemented by other abstract APS types and the Platform Types.

  • Platform Types is a set of reference documents about specific APS types used by the platform to expose its services for integration with APS applications and external management systems.

Services

There are several built-in services exposed by the platform on the APS bus as singleton APS resources. Such a service is called on the APS bus using its alias as follows.

  • Get the APS resource representing a service:

    GET /aps/2/services/<alias>
    
  • Run a custom operation exposed by a service:

    POST /aps/2/services/<alias>/<operation>
    
    { /* JSON body */ }
    

OSS Services

This is a list of APS types that define the API of OSS services.

Name

APS ID

Alias

ContactManagement

http://www.parallels.com/pa/pa-core-services/contact-management/1.0

contact-manager

PrivilegeManagement

http://www.parallels.com/pa/pa-core-services/privilege-management/1.0

privilege-manager

UserManagement

http://www.parallels.com/pa/pa-core-services/user-management/1.0

user-manager

DomainManagement

http://www.parallels.com/pa/pa-core-services/domain-management/1.1

domain-manager

ReverseZoneManagement

http://www.parallels.com/pa/pa-core-services/dns-reverse-zone-management/1.0

dns-reverse-zone-manager

HostManagement

http://www.parallels.com/pa/pa-core-services/host-management/1.0

host-manager

PeriodicTaskManagement

http://www.parallels.com/pa/pa-core-services/periodic-task-manager/1.1

periodic-task-manager

OnScreenNotificationManager

http://www.parallels.com/pa/pa-core-services/notification-manager/1.0

notification-manager

MessengerManager

http://www.parallels.com/pa/pa-core-services/messenger-manager/1.0

messenger-manager

PCPNotificationManager

http://www.parallels.com/pa/pa-core-services/pcp-notification-manager/1.0

pcp-notification-manager

ConfigurationManager

http://www.parallels.com/pa/pa-core-services/configuration-manager/1.0

configuration-manager

ResourceTypeManagement

http://www.parallels.com/pa/pa-core-services/resource-type-manager/1.1

resource-type-manager

BSS Services

This is a list of APS types that define the API of BSS services.

Name

APS ID

Alias

PaymentManagement

http://www.odin.com/billing/payment-management/1.3

payment-manager

PaymentMethodManagement

http://www.odin.com/billing/payment-method-management/1.5

payment-method-manager

PaymentRedirectManagement

http://www.odin.com/billing/payment-redirect-management/1.0

payment-redirect-manager

OrderManagementApplication

http://www.odin.com/billing/order-management/1.7

order-manager

SKUManagement

http://www.odin.com/oa/billing/sku/dispatcher/1.0

sku-manager

DiscountManagement

http://www.odin.com/oa/billing/discount-management/1.2

discount-manager

General Services

The following services are used to manage resources in both systems, OSS and BSS.

Name

APS ID

Alias

InitWizardConfig

http://odin.com/init-wizard/config/1.0

init-wizard

Collections

The platform data model contains many collections of resources, such as accounts, users, and subscriptions. Every collection is defined by an APS type and it has an alias that you can use to get all APS resources of the collection:

GET /aps/2/collections/<alias>

For example, to get a list of all accounts, send the following request:

GET /aps/2/collections/accounts

Abstract Collections

Name

APS ID

Alias

Application

applications

Account

accounts

User

users

Admin User

admin-users

Service User

service-users

UserService

user-services

Subscription

subscriptions

SubscriptionService

subscription-services

IPAddress

ip-addresses

Domain

domains

Domain Service

domain-services

ResellerProfile

http://aps-standard.org/types/core/profile/reseller/1.0

reseller-profiles

ServiceProfile

http://aps-standard.org/types/core/profile/service/1.0

service-profiles

OSS Collections

Name

APS ID

Alias

PAAccount

http://parallels.com/aps/types/pa/account/1.2

pa-accounts

PAUser

http://parallels.com/aps/types/pa/user/1.2

pa-users

PAAdminUser

http://parallels.com/aps/types/pa/admin-user/1.2

pa-admin-users

PAServiceUser

http://parallels.com/aps/types/pa/service-user/1.2

pa-service-users

Host

http://www.parallels.com/pa/pa-core-services/host-management/Host/1.1

hosts

HostService

http://www.parallels.com/pa/pa-core-services/host-management/HostService/1.0

host-services

PAIPAddress

http://www.parallels.com/pa/pa-core-services/ip-management/PAIPAddress/1.0

pa-ip-addresses

PAServiceTemplate

http://parallels.com/aps/types/pa/serviceTemplate/1.2

pa-service-templates

PASubscription

http://parallels.com/aps/types/pa/subscription/1.0

pa-subscriptions

BSS Collections

Name

APS ID

Alias

CustomerClass

http://www.odin.com/billing/CustomerClass/1.0

customer-classes

NotificationTemplate

http://www.odin.com/billing/NotificationTemplate/1.0

notification-templates

BssAccountInformation

http://parallels.com/pa/bss-account-info/1.0

bss-accounts

BSSResource

http://www.odin.com/billing/Resource/1.3

bss-resources

BSSSubscription

http://www.odin.com/billing/Subscription/1.0

bss-subscriptions

RDEReportFile

http://www.odin.com/rde/report-file/1.2

rde-report-files

RDEReportTemplate

http://www.odin.com/rde/report-template/1.2

rde-report-templates

RDETenant

http://www.odin.com/rde/tenant/2.0

rde-tenants

ServicePlan

http://www.odin.com/billing/ServicePlan/1.1

service-plans

ServicePlanCategory

http://www.odin.com/billing/ServicePlanCategory/1.0

service-plan-categories

ServiceTerms

http://www.odin.com/billing/ServiceTerms/1.0

service-terms

TaxCategory

http://www.odin.com/billing/TaxCategory/1.0

tax-categories