/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params

The following operation is supported on this resource:

  • GET - This API is used to fetch all the parameters that exists in the specific Configuration View
GET /configuration-views/{config-viewer-id}/configuration-view-paramsVersion 2

This API is used to fetch all the parameters that exists in the specific Configuration View.

Sample Usage

GET /configuration-views/{config-viewer-id}/configuration-view-params


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    config-viewer-idIntegerPathConfig Viewer ID Y
  • Sample Output XML:
    <configuration-view-params total="Integer" uri="/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params">
         <configuration-view-param uri="/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params/{id}">
               <id>Integer</id>
               <parameter>String</parameter>
               <index-parameter>Boolean</index-parameter>
               <display-name>String</display-name>
               <script-dependent>Boolean</script-dependent>
               <local-script-name>String</local-script-name>
               <customized>Boolean</customized>
               <editable>Boolean</editable>
               <configured-value-xpath>String</configured-value-xpath>
               <order>Integer</order>
         </configuration-view-param>
    </configuration-view-params>

  • Sample Output JSON:
    {
       "configuration-view-params" : {
         "@total" : "Integer" ,
         "@uri" :
         "/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params"
         ,
         "configuration-view-param" : {
           "@uri" :
           "/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params/{id}"
           ,
           "id" : "Integer" ,
           "parameter" : "String" ,
           "index-parameter" : "Boolean" ,
           "display-name" : "String" ,
           "script-dependent" : "Boolean" ,
           "local-script-name" : "String" ,
           "customized" : "Boolean" ,
           "editable" : "Boolean" ,
           "configured-value-xpath" : "String" ,
           "order" : "Integer"
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: ManageConfigViewersCap