Get detailed job information by job ID (GET)

Description

URL

scheme://domain:port/platform/ws/jobs/{jobIds}

Description

Gets detailed job information for jobs that have the specified job IDs.

You can only get information about jobs submitted by the logged on user account. You must be a cluster administrator or LSF user group administrator to get information about jobs submitted by other users.

To specify multiple job IDs, separate with a comma(,). For example: 532,533.

The job ID cannot be 0.

HTTP Method

GET

Parameters

NONE

Request

Request-Method

GET

Request-URI

/platform/ws/jobs/{jobIds}

Request-Header

Name

Value

Accept

application/xml or application/json

Message-body

empty

Response

Response-Code

  • 200 Successful: Request was successful.
  • 403 Forbidden: Access restricted by role-based access control permissions.
  • 404 Not Found: No jobs that match the specified criteria were found.
  • 500 Internal Server Error: Exception occurred.

Response-Header

Name

Value

Content-Type

application/xml or application/json

Message-body

Success Message If successful, returns detailed information about jobs.

For additional information, refer to the schema file GUID-5354f7f9-1722-4906-a4b9-6c5b961edd56.xsd.

<jobs total="%s">
 <atom:link href="%s" rel="self"/>
 <job>
  <command>%s</command>
  <exHosts>%s</exHosts>
  <fromHost>%s</fromHost>
  <jobId>%s</jobId>
  <jobName>%s</jobName>
  <jobStatus>%s</jobStatus>
  <queue>%s</queue>
  <submitTimeGMT>%s</submitTimeGMT>
  <user>%s</user>
  <application>%s</application>
  <askedHostsStr>%s</askedHostsStr>
  <cpuTime>%s</cpuTime>
  <cwd>%s</cwd>
  <description>%s</description>
  <execCwd>%s</execCwd>
  <execHome>%s</execHome>
  <execUserName>%s</execUserName>
  <exitStatus>%s</exitStatus>
  <infile>%s</infile>
  <jobGroup/>
  <mem>%s</mem>
  <nthreads>%s</nthreads>
  <numProcessors>%s</numProcessors>
  <outfile>%s</outfile>
  <pendReason>%s</pendReason>
  <pgidStr>%s</pgidStr>
  <pidStr>%s</pidStr>
  <priority>%s</priority>
  <projectName>%s</projectName>
  <resReq/>
  <runLimit>%s</runLimit>
  <runTime>%s</runTime>
  <swap>%s</swap>
  <userGroup/>
  <sTime>%s</sTime>
  <uTime>%s</uTime>
 </job>
 <job>
 ...
 </job>
</jobs>
Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file GUID-977db1c3-64d1-4996-b8df-e17e3df06846.xsd.

<error>
  <message>
     %s
  </message>
</error>

Example: Get detailed information about jobs 236, 237, and 289

# Request
GET /platform/ws/jobs/236,237,289 HTTP/1.1
Host: www.example.org
# Response
200 Successful
Content-Type: application/xml;

<jobs total=”3”>
<atom:link rel="self" 
		href="http:// www.example.org/platfom/ws/jobs/236,237,289"/>
<job>
	<id>236</id>
	…
</job>
<job>
	<id>237</id>
	…
</job>
<job>
	<id>289</id>
	…
</job>
<jobs>