/api/space/software-management/packages/{id}/exec-remove

The following operation is supported on this resource:

  • POST - Remove software from device
POST /packages/{id}/exec-removeVersion 1

This API removes the software package on the real device, and removes the device-software association from Space DB.

Sample Usage

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

POST /packages/{id}/exec-remove?queue=<queue>&schedule=<schedule>


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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idintPathThe ID for the software package under operation. Y
    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-remove>
      <devices>
        <device href= "/api/space/device-management/devices/524351" />
      </devices>
    </exec-remove>

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

  • Sample Input JSON:
    {
      "exec-remove":
       {
       "devices":
        {
         "device":
          {"@href": "/api/space/device-management/devices/524351"}
        }
       }

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

  • Access Control

    The following capabilities are required to access this API: RemoveImageCap