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:
The guide contains the following documents:
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 */ }
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.0 | 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.0 | 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.0 | resource-type-manager |
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.0 | payment-manager |
| PaymentMethodManagement | http://www.odin.com/billing/payment-method-management/1.0 | payment-method-manager |
| PaymentRedirectManagement | http://www.odin.com/billing/payment-redirect-management/1.0 | payment-redirect-manager |
| OrderManagement | http://www.odin.com/billing/order-management/1.0 | order-manager |
| SKUManagement | http://www.odin.com/oa/billing/sku/dispatcher/1.0 | sku-manager |
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 |
The platform data model contains many collections of resources, such as accounts, user, 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
| Name | APS ID | Alias |
|---|---|---|
| Application | http://aps-standard.org/types/core/application/1.0 | applications |
| User | http://aps-standard.org/types/core/user/1.0 | users |
| Service User | http://aps-standard.org/types/core/service-user/1.0 | service-users |
| Admin User | http://aps-standard.org/types/core/admin-user/1.0 | admin-users |
| UserService | http://aps-standard.org/types/core/user/service/1.0 | user-services |
| Account | http://aps-standard.org/types/core/account/1.0 | accounts |
| Subscription | http://aps-standard.org/types/core/subscription/1.0 | subscriptions |
| SubscriptionService | http://aps-standard.org/types/core/subscription/service/1.0 | subscription-services |
| ServiceProfile | http://aps-standard.org/types/core/profile/service/1.0 | service-profiles |
| ResellerProfile | http://aps-standard.org/types/core/profile/reseller/1.0 | reseller-profiles |
| IPAddress | http://aps-standard.org/types/ip-address/1.1 | ip-addresses |
| Domain | http://aps-standard.org/types/dns/domain/1.0 | domains |
| Domain Service | http://aps-standard.org/types/dns/domain/service/1.0 | domain-services |
| 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.1 | pa-service-templates |
| PASubscription | http://parallels.com/aps/types/pa/subscription/1.0 | pa-subscriptions |
| 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 |
| ServicePlan | http://www.odin.com/billing/ServicePlan/1.0 | 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 |