/api/space/script-management/scripts/exec-remove (v1)

The following operations are supported on this resource:

    PUT /scripts/exec-remove
    (Deprecated)
    Version 1

    This API removes scripts from devices.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    PUT /scripts/exec-remove?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
      schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <scriptMgmts>
       <scriptMgmt>
          <deviceId>4117</deviceId>
          <scriptId>1114117</scriptId>
          <scriptVersionSelected>1.1</ scriptVersionSelected>
          <scriptParams>
              <scriptParam>
                  <paramName>paramName</paramName>
                  <paramValue>paramValue</paramValue>
              </scriptParam>
          </scriptParams>
       </scriptMgmt>
       <scriptMgmt>
          <deviceId>4118</deviceId>
          <scriptId>1114119</scriptId>
          <scriptVersionSelected>1.1</ scriptVersionSelected>
          <scriptParams>
              <scriptParam>
                  <paramName>paramName</paramName>
                  <paramValue>paramValue</paramValue>
              </scriptParam>
          </scriptParams>
       </scriptMgmt>
    </scriptMgmts>

  • Sample Output XML:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <task>
      <id>786496</id>
    </task>

  • Sample Input JSON:
    {"scriptMgmts":
      [{"scriptMgmt":
      {"scriptId":"786432",
         "scriptVersionSelected":"1.1",
         "deviceId":"983043",
         "scriptParams":
         [{"scriptParam":
           {"paramName":"test",
           "paramValue":"test"}
      }]
      }
    }]
    }

  • Sample Output JSON:
    task:
    {
          id: 786496
    }

  • Access Control

    The following capabilities are required to access this API: RemoveScriptCap