REST Resources

/api/space/script-management/scripts/exec-enable

The following operations are supported on this resource:

  • POST - Enable scripts on devices
POST /scripts/exec-enableVersion 2

This API enables scripts on devices. Here a script and a device are passed as reference URLs (href).

Sample Usage

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

POST /scripts/exec-enable?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:
    <exec-enable>
       <scriptMgmt>
         <script href="/api/space/script-management/scripts/294912" />
         <device href="/api/space/device-management/devices/458753" />
         <scriptVersionSelected>1.1</scriptVersionSelected>
         <scriptParams>
           <scriptParam>
             <paramName>paramName</paramName>
             <paramValue>paramValue</paramValue>
           </scriptParam>
         </scriptParams>
       </scriptMgmt>
    </exec-enable>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/688128">
      <id>688128</id>
    </task>

  • Sample Input JSON:
    {"exec-enable":
      [{"scriptMgmt":
         {"script":{"@href": "/api/space/script-management/scripts/294912"},
         "scriptVersionSelected":"1.1",
         "device":{"@href": "/api/space/device-management/devices/458753"},
         "scriptParams":
         [{"scriptParam":
           {"paramName":"test",
           "paramValue":"test"}
      }]
      }
     }]
    }

  • Sample Output JSON:
    {"task":{"@href":"/api/space/job-management/jobs/688132",
      "id":688132
    }}

    • Access Control

    The following capabilities are required to access this API: EnableScriptCap