AWaws-samples
Applications

Create application profile

Changed on

Creates a new application profile with job submission form and script (admin access required)

post/api/applications/application

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Headers

X-EDH-USERstring required

SOCA username for authentication (must be admin)

X-EDH-TOKENstring required

SOCA authentication token

Request body application/x-www-form-urlencoded

profile_namestring required

Name for the application profile

submit_job_formstring required

HTML form for job submission parameters

submit_job_scriptstring required

Job submission script template

submit_job_interpreterstring required

Script interpreter (scheduler name or system shell)

thumbnail_b64string base64

Base64 encoded thumbnail image for the application

Example request

{
  "profile_name": "ANSYS Fluent",
  "submit_job_form": "<form><input name='cores' type='number' /></form>",
  "submit_job_script": "#!/bin/bash module load ansys fluent -g",
  "submit_job_interpreter": "bash",
  "thumbnail_b64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg=="
}

Response

Application profile created successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "ANSYS Fluent created successfully"
}

Changes

  • v1058396b8f0f1Revision changes
    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API