GET /manageRequest/jobs/`{job_id}`

Use this method to monitor the status of a management request.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/manageRequest/jobs/{job_id}

where {job_id} is the job ID that was returned by the POST /manageRequest method.

Query parameters

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.
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
progress						Double	Percentage complete of the bulk management job. This can be one of the following values. 0.0. Created. > 0.0. In progress. 100.0. Complete.
result						Integer	Result of the job. This can be one of the following values. 0. Created. 50. In progress. 100. Complete.
results						Array of objects	Result of the bulk management jobs
	messageBundle					String	Location where messages.properties can be found if it is not located in the default task management bundle. This value is always com.lenovo.lxca.discovery.bundle.tasks.messages.
	messageID					String	Message ID (0509_LONG)
	messageAttributes					String	Message arguments. This can be one of the following values. device IP if not null device serial number if not null device UUID
	progress					Long	Percentage complete of the management job. If the job is complete, JOB_DONE is returned.
	result					String	Result of the request. This can be one of the following values. success. The request was successful. failed. The request failed.
	resultLongDescription					String	Long description result
	resultShortDescription					String	Short description result
	status					Object	Status details about the list of management steps
		description				Array of objects	List of message descriptions
			messageBundle			String	Location where messages.properties can be found if it is not located in the default task management bundle. This value is always com.lenovo.lxca.discovery.bundle.tasks.messages.
			messageID			String	Message ID for the set of management steps
		percentage				Long	Percentage complete of the set of management steps
		state				String	State of the set of management steps. The can be one of the following values. ERROR RUNNING RUNNING_COMPLETE
		substatus				Array of objects	Results of each of the task in the management job
			completed			Boolean	Indicates whether the task completed. This can be one of the following values. true. The step has completed. false. The task has not completed.
			id			String	Name of the management step
			longDescription			String	Long message description
			messageBundle			String	Location where messages.properties can be found if it is not located in the default task management bundle. This value is always com.lenovo.lxca.discovery.bundle.tasks.messages.
			messageID			String	Message ID of the management step
			progress			Long	Progress of the management step
			shortDescription			String	Short message description
			started			Boolean	Indicates if the management step has started. This can be one of the following values. true. The step has started. false. The step has not started.
			status			Object	Status details about the individual management step
				description		Array of objects	List of message descriptions
					messageBundle	String	Location where messages.properties can be found if it is not located in the default task management bundle. This value is always com.lenovo.lxca.discovery.bundle.tasks.messages.
					messageID	String	Message ID for the set of unmanagement steps
				percentage		Long	Percentage complete of the management step
				state		String	State of the management step. This can be one of the following values. ERROR PENDING RUNNING RUNNING_COMPLETE
			userAction			String	User action that is required
		summary				Object	Information about the job summary This summary consists of the following types of information: Description. Describes issues that occurred. Actions. Describes whether the job completed successfully, and if not, lists the steps that the user can perform to resolve the issue. You must provide enough information so that the user can resolve the issue without help from the Lenovo Support. Severity. Describes severity of the job. The job summary is optional for a job that completes successfully; however, it is good practice to set the summary, even when the severity is informational.
			actionArgs			Array of strings	List of action arguments for the message
			actionBundleKey			String	Bundle in which the user action is declared
			actionBundleName			String	Bundle in which the translated user action is located
			actionText			String	User action to use if there is no translation
			descriptionArgs			Array of strings	List of arguments for the message
			descriptionBundleKey				Bundle in which the message description is declared
			descriptionBundleName			String	Bundle in which the translated message description is located
			descriptionText			String	Message description to use if there is no translation
			severity			String	Severity of the subtask. This can be one of the following values. Informational. The request started or ended successfully. Warning. The request completed, but there are some problems that you must be aware of . You can decide if action is needed. Critical. The request failed. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result).
	taskid					Integer	Task ID
	time_spent					Long	Duration of the task in milliseconds
	uuid					String	UUID associated with the management
status							Status of the management job. This can be one of the following values. 0. Created. 50. Incomplete. 100. Done. 101. Done_Warnimg.

The following example is returned if the request is successful.

{
   "progress": 100,
   "result": 100,
   "results": [{
      "messageBundle": "com.lenovo.lxca.discovery.bundle.rest.messages",
      "messageID": "0509_LONG",
      "messageParameters": "10.243.9.106",
      "progress": 100,
      "result": "SUCCESS",
      "resultLongDescription": "The management job has completed successfully",
      "resultShortDescription": "Success",
      "status": {
         "description": [{
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1028_LONG"
         }],
         "percentage": 100,
         "state": "Complete"
         "substatus": [{
            "completed": true,
            "id": "STARTING",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1000_SHORT",
            "longDescription": "Starting endpoint management job",
            "progress": 100,
            "shortDescription": "Starting",
            "started": true,
            "status": {
               "description": [{
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1028_LONG"
               }],
               "percentage": 100,
               "state": "Complete"
            },
            "userAction": ""
         },
         ...,
         {
            "completed": true,
            "id": "CONFIGURATION",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1010_SHORT",
            "longDescription": "Configuring endpoint for management",
            "progress": 100,
            "shortDescription": "Configuration",
            "started": true,
            "status": {
               "substatus": [{
                  "completed": true,
                  "id": "CFG_NTP",
                  "longDescription": "Configuring NTP",
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1011_SHORT",
                  "progress": 100,
                  "shortDescription": "NTP",
                  "started": true,
                  "status": {
                     "description": [{
                        "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                        "messageID": "1028_LONG"
                     }],
                     "percentage": 100,
                     "state": "Complete"
                  },
                  "userAction": "[{\"format\":[\"paragraph\"],\"text\":\"The problem might be caused by 
                                 the device momentary loosing connection to the management server during 
                              the management process. Either attempt to manage the device again, or  
                              manually set the management NTP server and time zone information using 
                              the management-controller interface.\"},
                              {\"format\":[\"paragraph\"],\"text\":\"The management-controller firmware 
                              for the device might not support the management NTP server settings or 
                              the time zone that is currently set in the management server. Update the 
                              management-controller firmware to the latest version, and then either 
                              attempt to manage the device again, or manually set the management NTP 
                              server and time zone information using the management-controller 
                              interface.\"}]",
               }
               {
                  "completed": true,
                  "id": "CFG_SECURITY",
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1012_SHORT",
                  "longDescription": "Configuring security",
                  "progress": 100,
                  "shortDescription": "Security",
                  "started": true,
                  "status": {
                     "description": [{
                        "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                        "messageID": "1028_LONG"
                     }],
                     "percentage": 100,
                     "state": "Complete"
                  },
                  "userAction": ""
               }],
               "description": [{
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1028_LONG"
               }],
               "percentage": 100,
               "state": "Complete"
            },
            "userAction": ""
         }],
         "summary": {
            "actionArgs": [],
            "actionBundleKey": "",
            "actionBundleName": ""
            "actionText": "",
            "descriptionArgs": [],
            "descriptionBundleKey": "1028_LONG",
            "descriptionBundleName": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "descriptionText": "The management job has completed successfully",
            "severity": "Informational",
         }
      },
      "taskid": 99,
      "time_spent": 43456,
      "uuid": "89b98fbf943f11e6bb84ff1e2236596d"
   }],
   "status": "DONE"
}

Give documentation feedback

GET /manageRequest/jobs/{job_id}

Authentication​

Request URL​

Query parameters​

Response codes​

Response body​