UsageMigrationSupport

Schema

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

{
  "name": "UsageMigrationSupport",
  "id": "http://aps-standard.org/inhouse-products/usageMigrationSupport/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "properties": {
    "usageManagedExtensionProducts": {
      "type": "array",
      "title": "IDs of the managed Extension-deployed Products from Connect",
      "items": {
        "type": "UsageMigratedProduct"
      }
    }
  },
  "operations": {
    "addManagedProduct": {
      "path": "addProduct",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    },
    "getPAYGCapabilities": {
      "path": "PAYGCapabilities",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      }
    }
  },
  "structures": {
    "UsageMigratedProduct": {
      "type": "object",
      "properties": {
        "productId": {
          "type": "string",
          "title": "Product ID from Connect"
        },
        "dateOfMigration": {
          "type": "string",
          "title": "Date when the product usage was migrated"
        }
      }
    }
  }
}

Properties

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
usageManagedExtensionProducts	Array of UsageMigratedProduct	Not Required

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
addManagedProduct	POST	/addProduct
getPAYGCapabilities	GET	/PAYGCapabilities

addManagedProduct

HTTP Request

POST /aps/2/resources/{aps-id}/addProduct

Description

Returns

getPAYGCapabilities

HTTP Request

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

Description

Returns

Structures

UsageMigratedProduct

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
productId	String	Not Required
dateOfMigration	String	Not Required

Examples

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

• Provisioning Resources

• Getting a Resource List

• Resource Configuration

• Unprovisioning Resources

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← Tenant

VmfSupport →