REST Resources

/api/space/device-management/devices/{device-id}/compute-configlet-parameter-values

The following operation is supported on this resource:

  • POST - This API is used to compute(retrieve) parameter values based on the xpaths defined in that parameter of the configlet and fetched against device configuration xml
POST /devices/{device-id}/compute-configlet-parameter-valuesVersion 5

This API is used to compute(retrieve) parameter values based on the xpaths defined in that parameter of the configlet and fetched against device configuration xml.

Sample Usage

POST /devices/{device-id}/compute-configlet-parameter-values


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    device-idIntegerPathDevice ID Y
  • Sample Input XML:
    <compute-configlet-parameter-values-request>
         <configlet href="/api/space/configuration-management/cli-configlets/{id}"/>
         <compute-configlet-parameter-values>
               <compute-configlet-parameter-value>
                   <parameter href="/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"/>
                   <dependent-parameter-values total="Integer">
                         <dependent-parameter-value>
                             <parameter href="/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"/>
                             <parameter-value>String</parameter-value>
                         </dependent-parameter-value>
                   </dependent-parameter-values>
               </compute-configlet-parameter-value>
         </compute-configlet-parameter-values>
    </compute-configlet-parameter-values-request>

  • Sample Output XML:
    <compute-configlet-parameter-values-response uri="/api/space/device-management/devices/{device-id}/compute-configlet-parameter-values">
         <compute-configlet-parameter-values>
               <compute-configlet-parameter-value>
                   <parameter
                         href="/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}" uri="/api/space/device-management/devices/{device-id}/compute-configlet-parameter-values">
                         <param-id>Integer</param-id>
                         <name>String</name>
                         <configlet-id>Integer</configlet-id>
                   </parameter>
                   <parameter-value>String</parameter-value>
                   <possible-values total="Integer">
                         <possible-value>String</possible-value>
                   </possible-values>
               </compute-configlet-parameter-value>
         </compute-configlet-parameter-values>
    </compute-configlet-parameter-values-response>

  • Sample Input JSON:
    {
       "compute-configlet-parameter-values-request" : {
         "configlet" : {
           "@href" : "/api/space/configuration-management/cli-configlets/{id}"
         } ,
         "compute-configlet-parameter-values" : {
           "compute-configlet-parameter-value" : {
             "parameter" : {
               "@href" :
               "/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"
             } ,
             "dependent-parameter-values" : {
               "@total" : "Integer" ,
               "dependent-parameter-value" : {
                 "parameter" : {
                   "@href" :
                   "/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"
                 } ,
                 "parameter-value" : "String"
               }
             }
           }
         }
       }
    }

  • Sample Output JSON:
    {
       "compute-configlet-parameter-values-response" : {
         "@uri" :
         "/api/space/device-management/devices/{device-id}/compute-configlet-parameter-values" ,
         "compute-configlet-parameter-values" : {
           "compute-configlet-parameter-value" : {
             "parameter" : {
               "@href" :
               "/api/space/configuration-management/cli-configlets/{configletId}/cli-configlet-params/{paramId}"
               ,
               "@uri" :
               "/api/space/device-management/devices/{device-id}/compute-configlet-parameter-values"
               ,
               "param-id" : "Integer" ,
               "name" : "String" ,
               "configlet-id" : "Integer"
             } ,
             "parameter-value" : "String" ,
             "possible-values" : {
               "@total" : "Integer" ,
               "possible-value" : "String"
             }
           }
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: ApplyCliTemplateCap2, ReadDevices