Skip to main content

GET /api/v1/jobs-management/schedules/{id}

Use this method to return information about a specific schedule job.

Note
This REST API requires Lenovo XClarity Orchestrator v2.1 or later.

Authentication​

Authentication with username and password is required.

Resource URI​

GET https://{orchestrator_server_IP}/api/v1/jobs-management/schedules/{id}

where {id} is the ID of the scheduled job. To obtain the scheduled job ID, use GET /api/v1/jobs-management/schedules.

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).

AttributeTypeDescription
idStringScheduled job ID
createdByStringName of the user that created the schedule
creationTimestampStringTimestamp when the scheduled job was created.

This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage.

jobIDStringJob ID
launchedTimestampStringTimestamp when the scheduled job ran

This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage.

metadataObjectInformation about the operation to be performed for this job
 bodyObjectRequest body of the operation
 methodStringMethod. This value is always POST.
 pathStringURI of the operation, including query parameters
statusStringJob status (translated). For a job with subtasks, this is most severe status of all subtsaks. This can be one of the following values.
  • Cancelled. The schedule was canceled.
  • Error. An error prevented the job from running on schedule..
  • Launched. The job ran on schedule.
  • Pending. The job is scheduled for a later time.
statusKeyStringJob status key. For a job with subtasks, this is most severe status of all subtsaks. This can be one of the following values.
  • cancelled. The schedule was canceled.
  • error. An error prevented the job from running on schedule..
  • launched. The job ran on schedule.
  • pending. The job is scheduled for a later time.
scheduleTimestampStringTimestamp when the scheduled job is to run

This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage.

titleStringScheduled job title
_linksObjectResource URI (see Links)
{
   "id": "c3047feb4ad44ba2b956950c812ce36e",
   "createdBy": "user1",
   "creationTimestamp": "2024-01-29T17:41:03.429Z",
   "jobID": "156",
   "launchedTimestamp": "2024-01-29T17:41:08.355Z",
   "metadata": {
      "method": "POST",
      "path": "/api/v1/updates-management/updates",
      "body": {
         "activationRule": "ImmediateActivation",
         "forceUpdate": false,
         "groupIDs": [],
         "installPrerequisiteFirmware": false,
         "resourceIDs": [ "CFEC7691C59F3613A1D47ABA0113C99C-5B421B48D19F46FBAD1A20F620D670D2" ],
         "updateRule": "ContinueOnError"
      }
   },
   "scheduleTimestamp": "2024-01-10T13:00:00.000Z",
   "status": "Launched",
   "statusKey": "launched",
   "title": "test",
   "_links": {
      "rel": "self",
      "uri": "/api/v1/jobs-management/schedules/c3047feb4ad44ba2b956950c812ce36e"
   }
}