Previous topic

MembershipTenant

Next topic

Discount Management

Tenant

GraphViz

Schema

The considered APS type (download) looks as follows:

{
  "name": "Tenant",
  "id": "http://com.ingrammicro/appstore/tenant/1.4",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/abstract/types/unlimited-resource/1.0"
  ],
  "relations": {
    "account": {
      "type": "http://parallels.com/aps/types/pa/account/1.2",
      "required": true
    }
  },
  "properties": {
    "installed": {
      "type": "array",
      "items": {
        "type": "TenantAppsInfo"
      }
    },
    "actuallyInstalled": {
      "type": "array",
      "items": {
        "type": "TenantAppsInfo"
      }
    },
    "appstoreInstallDetails": {
      "type": "array",
      "items": {
        "type": "ApplicationInstallDetail"
      }
    },
    "settingsOption": {
      "type": "SettingsOption"
    }
  },
  "structures": {
    "TenantAppsInfo": {
      "type": "object",
      "properties": {
        "subsystem": {
          "type": "string",
          "description": "Subsystem ID"
        },
        "applications": {
          "type": "array",
          "description": "Subsystem application infos",
          "items": {
            "type": "TenantAppVersion"
          }
        }
      }
    },
    "TenantAppVersion": {
      "type": "object",
      "properties": {
        "storeAppId": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "enum": [
            "installed"
          ]
        }
      }
    },
    "ApplicationInstallDetail": {
      "type": "object",
      "properties": {
        "appId": {
          "type": "string"
        },
        "subSystemName": {
          "type": "string"
        },
        "userType": {
          "type": "string"
        },
        "countInstall": {
          "type": "integer"
        },
        "countUninstall": {
          "type": "integer"
        }
      }
    },
    "SettingsOption": {
      "type": "object",
      "properties": {
        "appsAvailabilityProperty": {
          "type": "array",
          "items": {
            "type": "Property"
          }
        }
      }
    },
    "Property": {
      "type": "object",
      "properties": {
        "jiraAppId": {
          "type": "string"
        },
        "availability": {
          "type": "string"
        }
      }
    }
  }
}

Properties

NAME

TYPE

ATTRIBUTES

DEFAULT

DESCRIPTION

installed

Array of TenantAppsInfo

Not Required

actuallyInstalled

Array of TenantAppsInfo

Not Required

appstoreInstallDetails

Array of ApplicationInstallDetail

Not Required

settingsOption

SettingsOption

Not Required

Relationship

NAME

TYPE

REQUIRED

DESCRIPTION

account

PAAccount

Yes

Structures

TenantAppsInfo

NAME

TYPE

ATTRIBUTES

DEFAULT

DESCRIPTION

subsystem

String

Not Required

applications

Array of TenantAppVersion

Not Required

TenantAppVersion

NAME

TYPE

ATTRIBUTES

DEFAULT

DESCRIPTION

storeAppId

String

Not Required

version

String

Not Required

state

Enum

Not Required

ApplicationInstallDetail

NAME

TYPE

ATTRIBUTES

DEFAULT

DESCRIPTION

appId

String

Not Required

subSystemName

String

Not Required

userType

String

Not Required

countInstall

Integer

Not Required

countUninstall

Integer

Not Required

SettingsOption

NAME

TYPE

ATTRIBUTES

DEFAULT

DESCRIPTION

appsAvailabilityProperty

Array of Property

Not Required

Property

NAME

TYPE

ATTRIBUTES

DEFAULT

DESCRIPTION

jiraAppId

String

Not Required

availability

String

Not Required

Examples

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