Table Of Contents

Previous topic

License Management

Next topic

Messaging Notifications

Application Packaging Standard

Last updated 18-Mar-2019

PAProductLicense

The APS type provides a set of properties of a product license that an application can require.

In this document:

Schema

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

{
  "name": "PAProductLicense",
  "id": "http://parallels.com/aps/types/pa/productLicense/1.1",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "global": true
  },
  "properties": {
    "licenseId": {
      "type": "integer",
      "required": true
    },
    "keyId": {
      "type": "string"
    },
    "keyNumber": {
      "type": "string"
    },
    "keyVersion": {
      "type": "string"
    },
    "updateToken": {
      "type": "string",
      "access": {
        "global": false
      }
    },
    "product": {
      "type": "string"
    },
    "productName": {
      "type": "string"
    },
    "productVersions": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "description": {
      "type": "string"
    },
    "features": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "active": {
      "type": "boolean"
    },
    "serverUrl": {
      "type": "string",
      "access": {
        "global": false
      }
    },
    "starts": {
      "type": "integer"
    },
    "expires": {
      "type": "integer"
    },
    "properties": {
      "type": "array",
      "items": {
        "type": "Property"
      }
    },
    "trial": {
      "type": "boolean"
    },
    "essentials": {
      "type": "boolean"
    },
    "pa": {
      "type": "boolean"
    }
  },
  "structures": {
    "Property": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    }
  }
}

Properties

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
active Boolean Not Required   Specifies if the license is active (true) or not (false).
description String Not Required   Description of the license.
essentials Boolean Not Required   Specifies if this is the license for the Odin Automation Essentials platform (true).
expires Integer Not Required   The expiration date of the license.
pa Boolean Not Required   Specifies if this is the license for the Odin Automation Premium platfrom (true).
product String Not Required   Platform short name.
productName String Not Required   Platform full name.
productVersions String array Not Required   List of the product versions where the current license is valid.
properties Property array Not Required   List of Property objects.
starts Integer Not Required   The start date of the license.
trial Boolean Not Required   Specifies if the license is trial (true).

Structures

Property

Specifies the structure of a license property.

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
name String Not Required   The name of the license property.
value String Not Required   The value of the license property. Typically, it specifies a limit on a resource or make the property enabled/disabled.

Examples

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