Get basic and detailed job information by job ID (POST)

Description

URL

scheme://domain:port/platform/ws/jobs/getbasicinfo

scheme://domain:port/platform/ws/jobs/getfullinfo

Description

Gets basic or detailed 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 to get information about jobs submitted by other users.

HTTP Method

POST

Parameters

Name

Description

ids

Mandatory. ID of the job for which to retrieve information. To specify multiple job IDs, separate with a comma(,). For example: 532,533.

The list of IDs cannot include 0.

Request

 

Request-Method

POST

Request-URI

/platform/ws/jobs/getbasicinfo

/platform/ws/jobs/getfullinfo

Request-Header

Name

Value

Accept

application/xml or application/json

Message-body

ids=%s

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 for getfullinfo

If successful, returns detailed information about jobs.

For additional information, refer to the schema file ./schemas/jobs/jobs.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>
  Success Message for getbasicinfo

If successful, returns basic information about jobs.

For additional information, refer to the schema file ./schemas/jobs/pseudojob.xsd.

<jobs total="%s">
  <atom:link href="%s" rel="self"/>
  <pseudoJob>
   <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>
  </pseudoJob>
  <pseudoJob>
   ...
  </pseudoJob>
</jobs>
  Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/jobs/error.xsd.

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

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

# Request
POST /platform/ws/jobs/getbasicinfo HTTP/1.1
Host: www.example.org

ids=236,237,289
# Response
200 Successful
Content-Type: application/xml;

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

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

# Request
POST /platform/ws/jobs/getfulinfo HTTP/1.1
Host: www.example.org

ids=236,237,289
# Response
200 Successful
Content-Type: application/xml;

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