Previous topic

RDEStat

Next topic

RecommEngineManagement

RDETenant

GraphViz

Schema

The considered APS type (download) looks as follows:

{
  "name": "RDETenant",
  "id": "http://www.odin.com/rde/tenant/2.2",
  "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,
      "backrel": false
    },
    "reportTemplates": {
      "type": "http://www.odin.com/rde/report-template/1.5",
      "collection": true
    },
    "reportFiles": {
      "type": "http://www.odin.com/rde/report-file/1.6",
      "collection": true
    }
  },
  "properties": {
    "reportType": {
      "type": "string",
      "required": true,
      "default": "RESELLER",
      "enum": [
        "RESELLER",
        "PROVIDER"
      ]
    },
    "invoiceReportsDisabledByParent": {
      "type": "boolean",
      "default": "false"
    },
    "invoiceReportsDisabledForResellers": {
      "type": "boolean",
      "default": "false"
    }
  },
  "operations": {
    "syncFromParent": {
      "path": "syncFromParent",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      }
    }
  }
}

The APS type is used to manage a collection of APS resources. To get a list of resources from that collection, use the following API call:

GET  /aps/2/collections/rde-tenants?<RQL-filter>

Properties

NAME

TYPE

ATTRIBUTES

DEFAULT

DESCRIPTION

reportType

Enum

Required

RESELLER

invoiceReportsDisabledByParent

Boolean

Not Required

false

invoiceReportsDisabledForResellers

Boolean

Not Required

false

Relationship

NAME

TYPE

REQUIRED

DESCRIPTION

account

PAAccount

Yes

reportTemplates

Collection of RDEReportTemplate

No

reportFiles

Collection of RDEReportFile

No

Custom Operations

OPERATION

VERB

PATH

RETURNS

Description

syncFromParent

GET

/syncFromParent

syncFromParent

HTTP Request

GET /aps/2/resources/{aps-id}/syncFromParent

Description

Returns

Examples

Usually, there is no need to operate a tenant directly. Examples on RDE operations are in the following sections: