InitWizardManager

APS Init Wizard data manager

GraphViz

Schema

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

{
  "name": "InitWizardManager",
  "id": "http://odin.com/init-wizard/init-wizard-management/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "operations": {
    "applyWizardData": {
      "path": "/applyWizardData/{appId}",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "appId": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "getWizardData": {
      "path": "/getWizardData/{appId}",
      "verb": "GET",
      "response": {
        "type": "InitWizardDataBss"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "appId": {
          "kind": "path",
          "type": "string"
        }
      }
    }
  },
  "structures": {
    "InitWizardDataBss": {
      "type": "object"
    }
  }
}

Custom Operations

OPERATION

VERB

PATH

RETURNS

Description

applyWizardData

POST

/applyWizardData/{appId}

“applyWizardData” custom operation (POST)

getWizardData

GET

/getWizardData/{appId}

Response.

“getWizardData” custom operation (GET) return AIW WD

applyWizardData

HTTP Request

POST /aps/2/resources/{aps-id}/applyWizardData/{appId}

Description

“applyWizardData” custom operation (POST)

Parameters

PARAMETER

TYPE

DESCRIPTION

appId

String

Returns

getWizardData

HTTP Request

GET /aps/2/resources/{aps-id}/getWizardData/{appId}

Description

“getWizardData” custom operation (GET) return AIW WD

Parameters

PARAMETER

TYPE

DESCRIPTION

appId

String

Returns

Response.

Structures

InitWizardDataBss

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.