BundlesManagementCBStore

Schema

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

{
  "name": "BundlesManagementCBStore",
  "id": "http://com.odin.platform/inhouse-products/bundles-management-cbstore/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "global": true
  },
  "properties": {
    "installed": {
      "type": "boolean",
      "required": true,
      "default": "false"
    }
  },
  "operations": {
    "getAllSettingsManagementSubsystems": {
      "path": "applications",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "BundlesManagementCBStoreInfo"
        }
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "getSettingManagementSubsystem": {
      "path": "applications/{subsystemName}",
      "verb": "GET",
      "response": {
        "type": "BundlesManagementCBStoreInfo"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "subsystemName": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "install": {
      "path": "applications/{subsystemName}/install",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "subsystemName": {
          "kind": "path",
          "type": "string"
        }
      }
    },
    "uninstall": {
      "path": "applications/{subsystemName}/uninstall",
      "verb": "POST",
      "response": {
        "type": "object"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "subsystemName": {
          "kind": "path",
          "type": "string"
        }
      }
    }
  },
  "structures": {
    "BundlesManagementCBStoreInfo": {
      "type": "object",
      "properties": {
        "storeAppId": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "default": "not_installed",
          "enum": [
            "not_installed",
            "installed_latest",
            "installed_update_available",
            "installation_not_available"
          ]
        },
        "version": {
          "type": "string"
        },
        "versionDisplayMode": {
          "type": "string",
          "default": "display_none",
          "enum": [
            "display_all",
            "display_none"
          ]
        },
        "applicationViewId": {
          "type": "string"
        },
        "applicationViewType": {
          "type": "string",
          "default": "open",
          "enum": [
            "open",
            "manage"
          ]
        },
        "installationMethod": {
          "type": "string",
          "default": "api",
          "enum": [
            "view",
            "api",
            "view_and_method",
            "not_available"
          ]
        },
        "uninstallationMethod": {
          "type": "string",
          "default": "api",
          "enum": [
            "api"
          ]
        }
      }
    }
  }
}

Properties

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
installed	Boolean	Required	false

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
getAllSettingsManagementSubsystems	GET	/applications
getSettingManagementSubsystem	GET	/applications/{subsystemName}
install	POST	/applications/{subsystemName}/install
uninstall	POST	/applications/{subsystemName}/uninstall

getAllSettingsManagementSubsystems

HTTP Request

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

Description

Returns

getSettingManagementSubsystem

HTTP Request

GET /aps/2/resources/{aps-id}/applications/{subsystemName}

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
subsystemName	String

Returns

install

HTTP Request

POST /aps/2/resources/{aps-id}/applications/{subsystemName}/install

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
subsystemName	String

Returns

uninstall

HTTP Request

POST /aps/2/resources/{aps-id}/applications/{subsystemName}/uninstall

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
subsystemName	String

Returns

Structures

BundlesManagementCBStoreInfo

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
storeAppId	String	Not Required
status	Enum	Not Required	not_installed
version	String	Not Required
versionDisplayMode	Enum	Not Required	display_none
applicationViewId	String	Not Required
applicationViewType	Enum	Not Required	open
installationMethod	Enum	Not Required	api
uninstallationMethod	Enum	Not Required	api

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.

← BundleTenant

FulfillmentProduct →