/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params/{param-id}

The following operations are supported on this resource:

  • GET - This API is used to fetch the specified parameter details of the specified configlet
  • GET - Gets a CLI configlet param by parm ID and confliglet ID
GET /cli-configlets/{configlet-id}/cli-configlet-params/{param-id}Version 3

This API is used to fetch the specified parameter details of the specified configlet.

Sample Usage

GET /cli-configlets/{configlet-id}/cli-configlet-params/{param-id}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    configlet-idIntegerPathConfiglet ID Y
    param-idIntegerPathParam ID Y
  • Sample Output XML:
    <cli-configlet-param uri="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params/{param-id}">
         <id>Integer</id>
         <configlet-id>Integer</configlet-id>
         <parameter>String</parameter>
         <display-name>String</display-name>
         <description>String</description>
         <parameter-scope>GLOBAL</parameter-scope>
         <parameter-type>READWRITE</parameter-type>
         <regex-value>String</regex-value>
         <configured-value-xpath>String</configured-value-xpath>
         <default-value>String</default-value>
         <selection-values-xpath>String</selection-values-xpath>
         <selection-values>String</selection-values>
         <order>Integer</order>
         <dependent-parameter-list>
               <dependent-parameter>
                   <parameter
                         href="/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}" uri="/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params/{param-id}">
                         <param-id>Integer</param-id>
                         <name>String</name>
                         <configlet-id>Integer</configlet-id>
                   </parameter>
               </dependent-parameter>
         </dependent-parameter-list>
    </cli-configlet-param>

  • Sample Output JSON:
    {
       "cli-configlet-param" : {
         "@uri" :
         "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params/{param-id}"
         ,
         "id" : "Integer" ,
         "configlet-id" : "Integer" ,
         "parameter" : "String" ,
         "display-name" : "String" ,
         "description" : "String" ,
         "parameter-scope" : "GLOBAL" ,
         "parameter-type" : "READWRITE" ,
         "regex-value" : "String" ,
         "configured-value-xpath" : "String" ,
         "default-value" : "String" ,
         "selection-values-xpath" : "String" ,
         "selection-values" : "String" ,
         "order" : "Integer" ,
         "dependent-parameter-list" : {
           "dependent-parameter" : {
             "parameter" : {
               "@href" :
               "/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"
               ,
               "@uri" :
               "/api/space/configuration-management/cli-configlets/{configlet-id}/cli-configlet-params/{param-id}"
               ,
               "param-id" : "Integer" ,
               "name" : "String" ,
               "configlet-id" : "Integer"
             }
           }
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: ViewCliTemplateCap

    GET /cli-configlets/{configlet-id}/cli-configlet-params/{param-id}Version 2

    This API is used to get the CLI configlet param by param ID and configlet ID.

    Sample Usage

    GET /cli-configlets/{configlet-id}/cli-configlet-params/{param-id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      configlet-idIntegerPathThe ID of the CLI configlet Y
      param-idIntegerPathThe ID of the CLI configlet param Y
  • Sample Output XML:

    <cli-configlet-param uri="/api/space/configuration-management/cli-configlets/ 3145734/cli-configlet-params/4390919">
      <default-value></default-value>
      <display-name>result-regex[4]</display-name>
      <id>4390919</id>
      <param-order>1</param-order>
      <param-type>READWRITE</param-type>
      <parameter>result-regex[4]</parameter>
      <xpath></xpath>
    </cli-configlet-param>

  • Access Control

    The following capabilities are required to access this API: ViewCliTemplateCap

      For other non-deprecated versions of this API, refer to :
    • version 1