InitWizardVendorCatalogConfig

If implemented by the core APS type of an APS application and, consequently, by the APS application instance, the InitWizardVendorCatalogConfig APS type allows the latter to communicate with the platform during the product deployment. The considered APS type declares some methods that the platform can call to create a set of resources types, a service template, a service plan, and other related billing objects using objects application provided based on what services available for that application in service catalog.

Schema

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

{
  "name": "InitWizardVendorCatalogConfig",
  "id": "http://odin.com/init-wizard-vendor-catalog/config/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "operations": {
    "fetchCatalog": {
      "path": "/fetchCatalog",
      "verb": "POST",
      "response": {
        "type": "InitWizardDefaults"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "request": {
          "kind": "body",
          "type": "FetchCatalogRequest"
        }
      }
    }
  },
  "structures": {
    "FetchCatalogRequest": {
      "type": "object",
      "properties": {
        "apsType": {
          "type": "string"
        },
        "offerMpns": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
fetchCatalog	POST	/fetchCatalog	InitWizardDefaults.	Return vendor product catalog.

fetchCatalog

HTTP Request

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

Description

Return vendor product catalog.

Parameters

PARAMETER	TYPE	DESCRIPTION
request	FetchCatalogRequest

Returns

InitWizardDefaults.

Structures

FetchCatalogRequest

Defines MPN application must load from product catalog

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
apsType	String	Not Required
offerMpns	Array of Object	Not Required

Examples

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

← InitWizardManager

ResellerProfile →