Table Of Contents

Previous topic

Configuration Management

Next topic

Domain Management

ConfigurationManager

Configuration Manager provides a custom opertaion to get some system properties. Used to get system properties

GraphViz

Schema

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

{
  "name": "ConfigurationManager",
  "id": "http://www.parallels.com/pa/pa-core-services/configuration-manager/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "global": true
  },
  "operations": {
    "getSystemProperty": {
      "path": "systemProperty",
      "verb": "GET",
      "response": {
        "type": "ParameterValue"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "name": {
          "kind": "query",
          "type": "string"
        },
        "account_id": {
          "kind": "query",
          "type": "integer"
        }
      }
    }
  },
  "structures": {
    "ParameterValue": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "BOOL",
            "NUM",
            "ENUM",
            "STR"
          ]
        },
        "value": {
          "type": "string"
        }
      }
    }
  }
}

The APS type is used to create a singleton APS resource exposing its operations for API calls. The call syntax depends on the operation. For example, a call of an operation that accepts input parameters both in the URL string and in the body looks as follows:

POST  /aps/2/services/configuration-manager/<operation-path>?<query-params>

{/*<body params>*/}

In the above call, the verb can be either GET, PUT, POST, or DELETE as specified in the definition of the operation.

Custom Operations

OPERATION

VERB

PATH

RETURNS

Description

getSystemProperty

GET

/systemProperty

If successful, this method returns a ParameterValue object in the response body.

Get the specified system property.

getSystemProperty

HTTP Request

GET /aps/2/services/configuration-manager/systemProperty

Description

Get the specified system property.

Parameters

PARAMETER

TYPE

DESCRIPTION

name

String

Property name

account_id

Integer

Account identifier in the platform.

Returns

If successful, this method returns a ParameterValue object in the response body.

Structures

ParameterValue

The structure contains a list of property name and value pairs.

NAME

TYPE

ATTRIBUTES

DEFAULT

DESCRIPTION

type

Enum

Not Required
The property type - {“BOOL”, “NUM”, “ENUM”, “STR”}.
Value type:
BOOL - boolean
NUM - number
ENUM - enumerated
STR - string

value

String

Not Required

The property value.

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.