VmfSupport

Schema

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

{
  "name": "VmfSupport",
  "id": "http://aps-standard.org/inhouse-products/vmf/2.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "public": true
  },
  "operations": {
    "getValidationSettings": {
      "path": "/validationSettings",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "getParameters": {
      "path": "/parameters",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "getConfig": {
      "path": "/config",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "validate": {
      "path": "/orders/validate",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "getTierConfig": {
      "path": "/tierConfig",
      "verb": "GET",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "createTierConfig": {
      "path": "/tierConfig",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "validateTierConfig": {
      "path": "/tierConfig/validate",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "submitTierConfig": {
      "path": "/tierConfig/submit",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    },
    "createValidateAndSubmitTierConfig": {
      "path": "/tierValidate",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "planApsId": {
          "kind": "query",
          "type": "string"
        }
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
getValidationSettings	GET	/validationSettings
getParameters	GET	/parameters
getConfig	GET	/config
validate	POST	/orders/validate
getTierConfig	GET	/tierConfig
createTierConfig	POST	/tierConfig
validateTierConfig	POST	/tierConfig/validate
submitTierConfig	POST	/tierConfig/submit
createValidateAndSubmitTierConfig	POST	/tierValidate

getValidationSettings

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
planApsId	String

Returns

getParameters

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
planApsId	String

Returns

getConfig

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
planApsId	String

Returns

validate

HTTP Request

POST /aps/2/resources/{aps-id}/orders/validate

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
planApsId	String

Returns

getTierConfig

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
planApsId	String

Returns

createTierConfig

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
planApsId	String

Returns

validateTierConfig

HTTP Request

POST /aps/2/resources/{aps-id}/tierConfig/validate

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
planApsId	String

Returns

submitTierConfig

HTTP Request

POST /aps/2/resources/{aps-id}/tierConfig/submit

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
planApsId	String

Returns

createValidateAndSubmitTierConfig

HTTP Request

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

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
planApsId	String

Returns

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.

← UsageMigrationSupport

Messaging Notifications →