PUT /tasks/<job_list>

Use this PUT method to cancel one or more jobs (tasks).

Note: This API requires Lenovo XClarity Administrator v1.4.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

PUT https://<management_server_IP>/tasks/<job_list>

where <job_list> is a list of one or more job IDs, separated by a comma (for example, 10,11,12). To obtain the job IDs, use the GET /tasks method.

Query parameters

None

Request body

Table 1. Add a cancel callback to a created job
Attributes Required / Optional Type Description
cancelRESTBody Required when cancelRESTMethod is PUT or POST Object Request body for the cancel action, specified as a JSON key-value pair (for example, "a":"b"). JSON formatted request body that is required to cancel the job, specified as a key-value pairs
cancelRESTMethod Required String REST method to cancel the job. This can be one of the following values.
  • GET

  • POST

  • PUT

  • DELETE

cancelURL Required String URL to cancel the job
expirationTimeOut Required Integer Number of seconds after which the job expires. Use -1 for jobs that do not expire.
The following example cancels the specified jobs.
{
   "cancelRESTBody": {
      "DeviceList": [{
         "ServerList": [{ 
            "UUID": "8BFBADCC33CB11E499F740F2E9903640",
            "Components": [{
               "Fixid": "lnvgy_fw_imm2_tcoo17g-3.00_anyos_noarch",
               "Component": "IMM2 (Backup)"
            },
            {
               "Fixid": "lnvgy_fw_imm2_tcoo17g-3.00_anyos_noarch",
               "Component": "IMM2 (Primary)"
            }]
         }]
      }]
   },
   "cancelRESTMethod":"PUT",
   "cancelURL":"/updatableComponents?action=cancelApply&jobID=1",
   "expirationTimeOut": 60
}

Response codes

Code Description
200 OK
400 Bad request
401 Unauthorized. The user could not be authenticated.
403 Forbidden. The server could not authenticate this session.
404 Not found. The <id> does not exist.
412 Precondition failed.
500 Internal server error. An internal error occurred.

Response body

None