The following operation is supported on this resource:

  • POST - Execute scripts on device
POST /exec-scriptsVersion 2

This API executes 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 /exec-scripts?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:
         <script href="/api/space/script-management/scripts/294912" />
         <device href="/api/space/device-management/devices/458753" />

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

  • Sample Input JSON:
         {"script":{"@href": "/api/space/script-management/scripts/294912"},
         "device":{"@href": "/api/space/device-management/devices/458753"},

  • Sample Output JSON:

  • Access Control

    The following capabilities are required to access this API: ExecuteScriptCap