GET /tasks/schedules`{job_id}`

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

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/tasks/schedules{job_id}

where {job_id} is the ID of the scheduled job. To obtain the scheduled job IDs, use GET /tasks/schedules.

Query parameters

None

Request body

None

Response codes

Code	Description	Comments
200	OK	The request completed successfully.
400	Bad Request	A 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.
401	Unauthorized	The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403	Forbidden	The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404	Not found	A specified resource cannot be found. A descriptive error message is returned in the response body.
409	Conflict	There is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500	Internal Server Error	An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes			Type	Description
componentIDs			Array of strings	List of UUIDs of the devices or resource groups that are the target for the action. To obtain the device and resource group IDs, use GET /chassis, GET /nodes, GET /storage, GET /switches, and GET /resourceGroups.
createdBy			String	User name that created the scheduled job
creationDate			String	Timestamp when the scheduled job was created
description			String	Description of the scheduled job
execDate			String	Timestamp when the scheduled job is to run next.
id			String	ID of the scheduled job
jobIDs			Array of strings	List of IDs for all jobs that were started from the schedule
lastExecDate			String	Timestamp when the scheduled job was last run
matchEverything			Boolean	Indicates whether the action is to be run against all managed devices. This can be one of the following values. true. The action is to be run against all managed devices false. The action is run against only the managed device that is specified by the target attribute.
name			String	Name of the scheduled job
nextExecDate			String	Timestamp for the next scheduled run time of the job
state			String	State of the scheduled job. This can be one of the following values: ACTIVE ENDED PAUSED
targets			String	Device or resource group name that is the target for the job. If not application, the value is NONE. If more there is more than one target, the value is Multiple Targets.
triggerAction			Object	Information about the action that you want to schedule.
	actionBundleKey		String	The bundle in which the user action is declared
	actionBundleTitle		String	The bundle in which the translated user action is located
	actionID		String	ID of the action to be performed. To obtain the action IDs, use GET /tasks/schedules/actions.
	actionType		String	Type of action to be performed. This can be one of the following value: CUSTOM_REST REST
	restBody		String	REST request body for the action to be run.
	restHeaders		Array of objects	REST request header for the action to be run.
		headerKey	String
		headerValue	String
	restMethod		String	REST method of the action to be run. This can be one of the following values: GET PUT POST DELETE
	restURL		String	REST URL of the job to be run.
type			String	Type of schedule. This can be one of the following values. ONE_TIME. The job runs one time on all target devices. If the specified start and end date are in the past, the job runs imminently. RECURRING. The job runs on the specified dates and times on all target devices. EVENT_TRIGGERED. The job runs when a specified event occurs. This job runs only on the device that generated the event.

The following example is returned if the request is successful.

{
   "componentIDs": [
      "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
      "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC"],
   "createdBy": "ADMIN",
   "creationDate": "2017-10-26T15:14:44Z",
   "description": "",
   "execDate": "2017-10-26T04:00:00Z",
   "id": "1509030884611",
   "jobIDs": [],
   "lastExecDate": "2017-10-26T15:15:13Z",
   "matchEverything": false,
   "name": "Power off",
   "nextExecDate": "Not Available",
   "state": "ENDED"
   "targets": " Multiple Targets",
   "triggerAction": {
      "bundleTitle": "com.lenovo.lxca.discovery.bundle.jobs.jobActions",
      "bundleKey": "PowerOff1",
      "id": "PowerOff001",
      "restBody": "{}",
      "restHeaders": [],
      "restMethod": "PUT",
      "restURL": "/manage/power",
      "type": "REST"
   },
   "type": "ONE_TIME"
}

Give documentation feedback

GET /tasks/schedules{job_id}

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​