Get job status
Gets the status of the specified job.
This topic includes the following sections:
Request
HTTP method: GET
URL: https://<hostname>:<port>/<baocdp|baoap>/rest/job/<JOB_ID>/status
In the URL
- <JOB_ID> represents the job for which to get status
<baocdp|baoap> represents the TrueSight Orchestration component you are accessing (CDP or AP)
Header: See HTTP-request-and-response-headers for header information, such as required authentication token.
Request body properties
This call does not require a request body.
Response
If successful, this method returns the status the specified job.
Response body properties
Property | Description |
|---|---|
ProcessName | Fully qualified name of the process running |
name | Process name |
peerId | ID of the peer on which the process was executed |
startTime | Time the job started |
status | Status of the job |
outputParameters | List of output parameters returned by the process |
Response JSON:
processName: ":AutoPilot-AD-Utilities:HTTP:Get"
name: "Get"
peerId: "urn:jxta:uuid-59616261646162614E50472050325033E4830C5CEFF54C8284FFA9C2FE3C3B8503"
startTime: "Wed Dec 31 17:59:59 CST 1969"
status: "COMPLETED"
outputParameters: [4]
0: {
name: "message body"
value: "<result> <message-body><!doctype html><html itemscope="" itemtype="http://schema.org/WebPage" lang="en-IN"><head><meta content="/images/google_favicon_128.png" itemprop="image"><title>Google</title><script>........</message-body> </result>"
}
1: {
name: "status reason"
value: "<result>OK</result>"
}
2: {
name: "status code"
value: "<result>200</result>"
}
3: {
name: "header lines"
value: "<result> <header-lines> <Date>Mon, 06 Apr 2015 13:39:45 GMT</Date> <Expires>-1</Expires> <Cache-Control>private, max-age=0</Cache-Control> <Content-Type>text/html; charset=ISO-8859-1</Content-Type> <Server>gws</Server> <X-XSS-Protection>1; mode=block</X-XSS-Protection> <X-Frame-Options>SAMEORIGIN</X-Frame-Options> <Alternate-Protocol>80:quic,p=0.5</Alternate-Protocol> <Accept-Ranges>none</Accept-Ranges> <Vary>Accept-Encoding</Vary> <Transfer-Encoding>chunked</Transfer-Encoding> </header-lines> </result>"
}
Job statuses
The following table lists the possible job statuses that can be returned.
Status | Description |
|---|---|
Assigned | The process is started, running, or paused |
Completed | The process executed successfully |
Compensated | The process failed to execute successfully |
Cancelled | The process was cancelled |
Status codes and messages
For more details about HTTP response codes, see HTTP response codes.
HTTP code | Message | Description |
|---|---|---|
200 | OK | Request succeeded |
Invalid input. No result generated | The specified job ID does not exist | |
401 | Unauthorized | |
405 | Method not allowed |
Video demonstration
The following BMC Communities video (7:30) is part one of a two-part series on using REST to execute workflows. This video demonstrates how to log into an API server, generate an authentication code, and use the code to get process details, execute a workflow (process), retrieve a list of active modules, and get a job's status.
The second part of the video demonstrates how to use the HTTP adapter to perform the same tasks and is available in the TrueSight Orchestration online documentation for the HTTP adapter.