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

The following operations are supported on this resource:

  • GET - This API is used to fetch a specific configuration view details based on the configuration view ID
  • PUT - This API is used to update/modify the existing configuration view
  • PATCH - This API is used to update the configuration view partially
  • DELETE - Delete the Configuration View
GET /configuration-views/{config-viewer-id}Version 2

This API is used to fetch a specific configuration view details based on the configuration view ID.

Sample Usage

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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    config-viewer-idIntegerPathConfig Viewer ID Y
  • Sample Output XML:
    <configuration-view
         href="/api/space/configuration-management/configuration-views/{id}" uri="/api/space/configuration-management/configuration-views/{config-viewer-id}">
         <id>Integer</id>
         <name>String</name>
         <domain-id>Integer</domain-id>
         <domain-name>String</domain-name>
         <view-type>FORMVIEW</view-type>
         <title>String</title>
         <device-family>String</device-family>
         <context>String</context>
         <description>String</description>
         <order>Integer</order>
         <creation-time>java.util.Date</creation-time>
         <last-updated-time>java.util.Date</last-updated-time>
         <last-modified-by>String</last-modified-by>
         <configuration-view-params uri="/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params">
               <configuration-view-param>
                   <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>
    </configuration-view>

  • Sample Output JSON:
    {
       "configuration-view" : {
         "@href" : "/api/space/configuration-management/configuration-views/{id}" ,
         "@uri" :
         "/api/space/configuration-management/configuration-views/{config-viewer-id}"
         ,
         "id" : "Integer" ,
         "name" : "String" ,
         "domain-id" : "Integer" ,
         "domain-name" : "String" ,
         "view-type" : "FORMVIEW" ,
         "title" : "String" ,
         "device-family" : "String" ,
         "context" : "String" ,
         "description" : "String" ,
         "order" : "Integer" ,
         "creation-time" : "java.util.Date" ,
         "last-updated-time" : "java.util.Date" ,
         "last-modified-by" : "String" ,
         "configuration-view-params" : {
           "@uri" :
           "/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params"
           ,
           "configuration-view-param" : {
             "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

    PUT /configuration-views/{config-viewer-id}Version 2

    This API is used to update/modify the existing configuration view.

    Sample Usage

    PUT /configuration-views/{config-viewer-id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      config-viewer-idIntegerPathConfig Viewer ID Y
  • Sample Input XML:
    <configuration-view>
         <name>String</name>
         <view-type>FORMVIEW</view-type>
         <title>String</title>
         <device-family>String</device-family>
         <context>String</context>
         <description>String</description>
         <order>Integer</order>
         <configuration-view-params>
               <configuration-view-param>
                   <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>
    </configuration-view>

  • Sample Output XML:
    <configuration-view
         href="/api/space/configuration-management/configuration-views/{id}" uri="/api/space/configuration-management/configuration-views/{config-viewer-id}">
         <id>Integer</id>
         <name>String</name>
         <domain-id>Integer</domain-id>
         <domain-name>String</domain-name>
         <view-type>FORMVIEW</view-type>
         <title>String</title>
         <device-family>String</device-family>
         <context>String</context>
         <description>String</description>
         <order>Integer</order>
         <creation-time>java.util.Date</creation-time>
         <last-updated-time>java.util.Date</last-updated-time>
         <last-modified-by>String</last-modified-by>
         <configuration-view-params uri="/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params">
               <configuration-view-param>
                   <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>
    </configuration-view>

  • Sample Input JSON:
    {
       "configuration-view" : {
         "name" : "String" ,
         "view-type" : "FORMVIEW" ,
         "title" : "String" ,
         "device-family" : "String" ,
         "context" : "String" ,
         "description" : "String" ,
         "order" : "Integer" ,
         "configuration-view-params" : {
           "configuration-view-param" : {
             "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"
           }
         }
       }
    }

  • Sample Output JSON:
    {
       "configuration-view" : {
         "@href" : "/api/space/configuration-management/configuration-views/{id}" ,
         "@uri" :
         "/api/space/configuration-management/configuration-views/{config-viewer-id}"
         ,
         "id" : "Integer" ,
         "name" : "String" ,
         "domain-id" : "Integer" ,
         "domain-name" : "String" ,
         "view-type" : "FORMVIEW" ,
         "title" : "String" ,
         "device-family" : "String" ,
         "context" : "String" ,
         "description" : "String" ,
         "order" : "Integer" ,
         "creation-time" : "java.util.Date" ,
         "last-updated-time" : "java.util.Date" ,
         "last-modified-by" : "String" ,
         "configuration-view-params" : {
           "@uri" :
           "/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params"
           ,
           "configuration-view-param" : {
             "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: EditConfigViewerCap

    PATCH /configuration-views/{config-viewer-id}Version 2

    This API is used to update the configuration view partially.

    Sample Usage

    PATCH /configuration-views/{config-viewer-id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      config-viewer-idIntegerPathConfig Viewer ID Y
  • Sample Patch XML:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <diff>
       <!--What you see below are just samples of patch operations that may be performed on this DTO.-->
       <!--For more information about patch document format please look at http://http://www.rfc-editor.org/rfc/rfc5261.txt-->
       <replace sel="configuration-view/name">
           <name>String</name>
       </replace>
       <replace sel="configuration-view/view-type">
           <view-type>FORMVIEW</view-type>
       </replace>
       <replace sel="configuration-view/title">
           <title>String</title>
       </replace>
       <replace sel="configuration-view/device-family">
           <device-family>String</device-family>
       </replace>
       <replace sel="configuration-view/context">
           <context>String</context>
       </replace>
       <replace sel="configuration-view/description">
           <description>String</description>
       </replace>
       <replace sel="configuration-view/order">
           <order>Integer</order>
       </replace>
       <replace sel="configuration-view/configuration-view-params">
           <configuration-view-params>
             <configuration-view-param>
                 <parameter>String</parameter>
                 <display-name>String</display-name>
                 <configured-value-xpath>String</configured-value-xpath>
                 <order>Integer</order>
             </configuration-view-param>
           </configuration-view-params>
       </replace>
    </diff>

  • Sample Output XML:
    <configuration-view
         href="/api/space/configuration-management/configuration-views/{id}" uri="/api/space/configuration-management/configuration-views/{config-viewer-id}">
         <id>Integer</id>
         <name>String</name>
         <domain-id>Integer</domain-id>
         <domain-name>String</domain-name>
         <view-type>FORMVIEW</view-type>
         <title>String</title>
         <device-family>String</device-family>
         <context>String</context>
         <description>String</description>
         <order>Integer</order>
         <creation-time>java.util.Date</creation-time>
         <last-updated-time>java.util.Date</last-updated-time>
         <last-modified-by>String</last-modified-by>
         <configuration-view-params uri="/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params">
               <configuration-view-param>
                   <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>
    </configuration-view>

  • Sample Output JSON:
    {
       "configuration-view" : {
         "@href" : "/api/space/configuration-management/configuration-views/{id}" ,
         "@uri" :
         "/api/space/configuration-management/configuration-views/{config-viewer-id}"
         ,
         "id" : "Integer" ,
         "name" : "String" ,
         "domain-id" : "Integer" ,
         "domain-name" : "String" ,
         "view-type" : "FORMVIEW" ,
         "title" : "String" ,
         "device-family" : "String" ,
         "context" : "String" ,
         "description" : "String" ,
         "order" : "Integer" ,
         "creation-time" : "java.util.Date" ,
         "last-updated-time" : "java.util.Date" ,
         "last-modified-by" : "String" ,
         "configuration-view-params" : {
           "@uri" :
           "/api/space/configuration-management/configuration-views/{config-viewer-id}/configuration-view-params"
           ,
           "configuration-view-param" : {
             "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"
           }
         }
       }
    }

  • DELETE /configuration-views/{config-viewer-id}Version 2

    Delete the Configuration View.

    Sample Usage

    DELETE /configuration-views/{config-viewer-id}


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      config-viewer-idIntegerPathConfig Viewer ID Y

    Access Control

    The following capabilities are required to access this API: DeleteConfigViewerCap