Get application parameters (GET)

Edit online

Description

URL

scheme://domain:port/platform/ws/applications/appParams

Description

Lists all parameters of an application.

HTTP Method

GET

Parameters

 Name Description
 

name

Required. Name of the application for which to retrieve information. The application must have the status Published.

Request

Request-Method

GET

Request-URI

 /platform/ws/applications/appParams?name=%s

Request-Header

 Name Value

Accept

application/xml or application/json

Message-body

empty

Response

Response-Code

  • 200 Successful: Request was successful.
  • 400 Bad Request: Application name is empty.
  • 403 Forbidden: Access restricted by role-based access control permissions.
  • 404 Not Found: No applications that match the specified criteria found, or the specified application does not have the status Published.
  • 500 Internal Server Error: Exception occurred.

Response-Header

 Name Value

Content-Type

application/xml or application/json

Message-body

 Success Message

If successful, returns information about application parameters.


<Application>
  <appParam>
   <id>%s</id>
   <value>%s</value>
   <type>%s</type>
   <label>%s</label>
   <defaultValue>%s</defaultValue>
   <mandatory>%s</mandatory>
  </appParam>
  <appParam>
    ...
  </appParam>
    ...
</Application>
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


# Request
POST /platform/ws/applications/appParams?name=generic HTTP/1.1
Host: www.example.org
Accept: application/xml

# Response
200 Successful
Content-Type: application/xml;

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Application total="24">
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>COMMANDTORUN</id>
    <label>Command to run</label>
    <mandatory>yes</mandatory>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>JOB_NAME</id>
    <label>Job Name</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>label1</id>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>label2</id>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>MIN_NUM_CPU</id>
    <label>Minimum number of proces-sors</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>MAX_NUM_CPU</id>
    <label>Maximum number of proces-sors</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>PROC_PRE_HOST</id>
    <label>Number of processors to use on each host</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>EXTRA_RES</id>
    <label>Resource Requirement string</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>label3</id>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>label4</id>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>RUNLIMITHOUR</id>
    <label>Hour</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>RUNLIMITMINUTE</id>
    <label>Minute</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>MAX_MEM</id>
    <label>Maximum memory size per pro-cess</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>label5</id>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>RERUNABLE</id>
    <label>This job is rerunnable</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>APP_PROFILE</id>
    <label>Application profile name</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>PRJ_NAME</id>
    <label>Project</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>RES_ID</id>
    <label>Reservation ID</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>LOGIN_SHELL</id>
    <label>Login Shell</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>QUEUE</id>
    <label>Submit to this Queue</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>EXTRA_PARAMS</id>
    <label>Other bsub op-tions</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>INPUT_FILE</id>
    <label>Input file</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>OUTPUT_FILE</id>
    <label>Output file</label>
  </AppParam>
  <AppParam>
    <defaultValue>-</defaultValue>
    <id>ERROR_FILE</id>
    <label>Error file</label>
  </AppParam>
</Application>