List Application by Category

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameList Application by Category
Description
Allowed Role(s)WM_USER
MethodGET
URI

v1/apps?category=category_option_1&category=category_option_2&....

cloudcenter-ccm-backend/api/v1/apps?category=category_option_1&category=category_option_2&....

Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/apps?category=NTier&category=SaaS"
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/apps?category=NTier&category=SaaS"
Release

Introduced in CloudCenter 4.0

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • See List Application Profile Categories for a list of categories.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: get.apps
actionparam: category=category_option_1&category=category_option_2&...

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Response

{
    "apps": [
        {
            "id": "136",
            "resource": "https://<URL>/v1/apps/136?version=1.0",
            "perms": [],
            "name": "AAANTIER",
            "version": null,
            "description": "",
            "serviceTierId": "N-TierExecution-136",
            "versions": [
                "1.0"
            ],
            "executor": "NTierExecutor",
            "category": "NTier"
        }
    ],
    "size": 1
} 

Request Attributes

category
  • Description: Application profile category. The category_option differs based on the options available in the List Application Profile Categories. See the Application Profiles section for the relevant release for a list of supported categories.
  • Type: String

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String

resource
  • Description: Unique URL to access this resource.
  • Type: String

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

version
  • Description: Version of the application

  • Type: String
revisionId
  • Description: Revision of the application version
  • Type: Number
serviceTierId
  • Description: Type of application tier (for example, Loadbalancer, database, AppCluster, or other tiers). This value is a concatenation of the Application Profile Type Name and the App ID.
    • First job serviceTierId = appName + "-" +appId
    • Child tier serviceTierId = tierName + "-" +appId
  • Type: String
executor
  • Description: Identifies how the application will be executed in the application layer. The options are:   
    • cmdLineExecutor
    • interactiveAppCommandExecutor
    • batchExecutor
    • forkExecutor
    • seqWflExecutor
    • MultitierAppExecutor
    • ChildTierAppExecutor
    • hadoopExecutor
    • NTierExecutor
    • SaaSExecutor
  • Type: Enumeration
category
  • Description: Application profile category
  • Type: String



Terms & Conditions Privacy Statement Cookies Trademarks