/api/space/script-management/scripts/{script-id}/parameters

The following operation is supported on this resource:

  • GET - Get all parameters by Script
GET /scripts/{script-id}/parametersVersion 2

This API finds all available parameters upon a given script.

Sample Usage

GET /scripts/{script-id}/parameters


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    script-idIntegerPathThe ID of the script from which to get the parameters. Y
  • Sample Output XML:
    <script-params total="3" size="3" uri="/api/space/script-management/scripts/163885/parameters">
      <script-param>
        <parameter>XPATHVARIABLE1</parameter>
        <description>Description</description>
        <parameter-scope>Device Specific</parameter-scope>
        <regex-value/>
        <configured-value-xpath/>
        <default-value>mydefaultvalue</default-value>
        <selection-value-xpath/>
        <selection-values/>
      </script-param>
      <script-param>
        <parameter>XPATHVARIABLE3</parameter>
        <description>Description</description>
        <parameter-scope>Entity Specific</parameter-scope>
        <regex-value/>
        <configured-value-xpath/>
        <default-value/>
        <selection-value-xpath> /device/interface-information/physical-interface/name/text() </selection-value-xpath>
        <selection-values/>
      </script-param>
      <script-param>
        <parameter>XPATHVARIABLE4</parameter>
        <description>Description</description>
        <parameter-scope>Global</parameter-scope>
        <regex-value/>
        <configured-value-xpath/>
        <default-value/>
        <selection-value-xpath/>
        <selection-values> myselectionvalue1,myselectionvalue2,myselectionvalue3 </selection-values>
      </script-param>
    </script-params>

  • Sample Output JSON:
    {
      "script-params": {
        "script-param": [
          {
            "parameter": "XPATHVARIABLE1",
            "description": "Description",
            "parameter-scope": "Device Specific",
            "regex-value": "",
            "configured-value-xpath": "",
            "default-value": "mydefaultvalue",
            "selection-value-xpath": "",
            "selection-values": ""
          },
          {
            "parameter": "XPATHVARIABLE3",
            "description": "Description",
            "parameter-scope": "Entity Specific",
            "regex-value": "",
            "configured-value-xpath": "",
            "default-value": "",
            "selection-value-xpath": " /device/interface-information/physical-interface/name/text() ",
            "selection-values": ""
          },
          {
            "parameter": "XPATHVARIABLE4",
            "description": "Description",
            "parameter-scope": "Global",
            "regex-value": "",
            "configured-value-xpath": "",
            "default-value": "",
            "selection-value-xpath": "",
            "selection-values": " myselectionvalue1,myselectionvalue2,myselectionvalue3 "
          }
        ],
        "@total": "3",
        "@size": "3",
        "@uri": "/api/space/script-management/scripts/163885/parameters"
      }
    }

  • Access Control

    The following capabilities are required to access this API: ViewScriptsCap