REST API Reference Guide

This document describes the REST API of the HEAppE Middleware.

Live API documentation: Swagger UI

GET /heappe/ClusterInformation/ListAvailableClusters

Get available clusters

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/ClusterInformation/RequestCommandTemplateParametersName

Get command template parameters name

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/ClusterInformation/CurrentClusterNodeUsage

Get actual cluster node usage

Query Parameters:

• sessionCode (string) – Session code

• clusterNodeId (integer) – ClusterNode ID

• projectId (integer) – Project ID

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/DataTransfer/RequestDataTransfer

Create Data Transfer

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/DataTransfer/CloseDataTransfer

CLose Data Transfer

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/DataTransfer/HttpGetToJobNode

Send HTTP GET to Job node

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/DataTransfer/HttpPostToJobNode

Send HTTP POST to Job node

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/FileTransfer/RequestFileTransfer

Create file transfer tunnel

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/FileTransfer/CloseFileTransfer

Close file transfer tunnel

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/FileTransfer/DownloadPartsOfJobFilesFromCluster

Download part of job files from Cluster

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/FileTransfer/ListChangedFilesForJob

Get all changes files during job execution

Query Parameters:

• sessionCode (string) – Session code

• submittedJobInfoId (integer) – SubmittedJobInfo ID

Status Codes:

• 200 OK – OK

• 204 No Content – No Content

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/FileTransfer/DownloadFileFromCluster

Download specific file from Cluster

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/JobManagement/CreateJob

Create job specification

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

PUT /heappe/JobManagement/SubmitJob

Submit job

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

PUT /heappe/JobManagement/CancelJob

Cancel job

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

DELETE /heappe/JobManagement/DeleteJob

Delete job

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobManagement/ListJobsForCurrentUser

Get all jobs for user

Query Parameters:

• sessionCode (string) – Session code

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobManagement/CurrentInfoForJob

Get current info for job

Query Parameters:

• sessionCode (string) – Session code

• submittedJobInfoId (integer) – SubmittedJobInfo ID

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/JobManagement/CopyJobDataToTemp

Copy job data to temp folder

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/JobManagement/CopyJobDataFromTemp

Copy job data from temp folder

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobManagement/AllocatedNodesIPs

Get Allocated Nodes IPs

Query Parameters:

• sessionCode (string) – Session code

• submittedTaskInfoId (integer) – SubmittedTaskInfo ID

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobReporting/ListAdaptorUserGroups

Get user groups

Query Parameters:

• sessionCode (string) – Session code

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobReporting/UserResourceUsageReport

Get resource usage report for user

Query Parameters:

• userId (integer) – User ID

• startTime (string) – StartTime

• endTime (string) – EndTime

• sessionCode (string) – SessionCode

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobReporting/UserGroupResourceUsageReport

Get resource usage for user group

Query Parameters:

• groupId (integer) – Group ID

• startTime (string) – StartTime

• endTime (string) – EndTime

• sessionCode (string) – SessionCode

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobReporting/AggregatedUserGroupResourceUsageReport

Get aggregated resource report usage for user groups

Query Parameters:

• startTime (string)

• endTime (string)

• sessionCode (string)

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobReporting/ResourceUsageReportForJob

Get resource usage for executed job

Query Parameters:

• sessionCode (string) – Session code

• jobId (integer) – Job ID

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobReporting/JobsStateAgregationReport

Get job state aggregation report

Query Parameters:

• sessionCode (string) – Session code

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/JobReporting/JobsDetailedReport

Get job detailed report

Query Parameters:

• sessionCode (string) – Session code

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/Management/InstanceInformation

Get HEAppE Information

Query Parameters:

• sessionCode (string) – SessionCode

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/Management/VersionInformation

Get HEAppE Version Information

Query Parameters:

• sessionCode (string) – SessionCode

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/Management/CommandTemplate

List Command Template

Query Parameters:

• sessionCode (string)

• id (integer)

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/Management/CommandTemplate

Create Static Command Template

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

PUT /heappe/Management/CommandTemplate

Modify Static Command Template

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/Management/CommandTemplates

List Command Templates

Query Parameters:

• sessionCode (string)

• projectId (integer)

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/Management/CommandTemplateFromGeneric

Create Command Template from Generic Command Template

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

PUT /heappe/Management/CommandTemplateFromGeneric

Modify Command Template based on Generic Command Template

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

DELETE /heappe/Management/RemoveCommandTemplate

Remove Command Template

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/Management/CommandTemplateParameter

Create Static Command Template

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

PUT /heappe/Management/CommandTemplateParameter

Modify Static Command Template

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

DELETE /heappe/Management/CommandTemplateParameter

Remove Static Command Template

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/Management/Project

Create project

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

PUT /heappe/Management/Project

Modify project

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

DELETE /heappe/Management/Project

Remove project

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/Management/ProjectAssignmentToCluster

Assign project to the cluster

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

PUT /heappe/Management/ProjectAssignmentToCluster

Modify project assignment to the cluster

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

DELETE /heappe/Management/ProjectAssignmentToCluster

Remove project assignment to the cluster

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/Management/SecureShellKey

Generate SSH key

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

PUT /heappe/Management/SecureShellKey

Regenerate SSH key

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

DELETE /heappe/Management/SecureShellKey

Remove SSH key

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/Management/GenerateSecureShellKey

Generate SSH key

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

PUT /heappe/Management/RegenerateSecureShellKey

Regenerate SSH key

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

DELETE /heappe/Management/RemoveSecureShellKey

Remove SSH key

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/Management/InitializeClusterScriptDirectory

Initialize cluster script directory for SSH HPC Account

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/Management/TestClusterAccessForAccount

Test cluster access for robot account

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/Management/TestClusterAccessForAccount

Test cluster access for robot account

Query Parameters:

• username (string)

• projectId (integer)

• sessionCode (string)

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/UserAndLimitationManagement/AuthenticateLexisToken

Provide user authentication via OpenId token.

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/UserAndLimitationManagement/AuthenticateUserOpenId

Provide user authentication via OpenId token.

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/UserAndLimitationManagement/AuthenticateUserOpenStack

Provide user authentication to OpenStack.

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/UserAndLimitationManagement/AuthenticateUserPassword

Provide user authentication

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /heappe/UserAndLimitationManagement/AuthenticateUserDigitalSignature

Provide user authentication

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/UserAndLimitationManagement/CurrentUsageAndLimitationsForCurrentUser

Get current resource usage

Query Parameters:

• sessionCode (string) – Session code

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /heappe/UserAndLimitationManagement/ProjectsForCurrentUser

Get projects for current user

Query Parameters:

• sessionCode (string)

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 404 Not Found – Not Found

• 413 Request Entity Too Large – Content Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error