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

Query Parameters:

  • SessionCode (string)

  • ClusterName (string)

  • NodeTypeName (string)

  • ProjectName (string)

  • AccountingString (array)

  • CommandTemplateName (string)

Status Codes:
Response JSON Object:

  • [].Description (string) – Description

  • [].Id (integer) – Id

  • [].Name (string) – Name

  • [].NodeTypes[].Accounting[].CreatedAt (string) – Created at date

  • [].NodeTypes[].Accounting[].Formula (string) – Formula

  • [].NodeTypes[].Accounting[].Id (integer) – Id

  • [].NodeTypes[].Accounting[].ModifiedAt (string) – Modified at date

  • [].NodeTypes[].Accounting[].ValidityFrom (string) – Validity from date

  • [].NodeTypes[].Accounting[].ValidityTo (string) – Validity to date

  • [].NodeTypes[].ClusterAllocationName (string) – Cluster allocation name

  • [].NodeTypes[].ClusterNodeTypeAggregation.AllocationType (string) – Allocation type

  • [].NodeTypes[].ClusterNodeTypeAggregation.Description (string) – Description

  • [].NodeTypes[].ClusterNodeTypeAggregation.Id (integer) – Id

  • [].NodeTypes[].ClusterNodeTypeAggregation.Name (string) – Name

  • [].NodeTypes[].ClusterNodeTypeAggregation.ValidityFrom (string) – Valid from

  • [].NodeTypes[].ClusterNodeTypeAggregation.ValidityTo (string) – Valid to

  • [].NodeTypes[].CoresPerNode (integer) – Number of cores per node

  • [].NodeTypes[].Description (string) – Description

  • [].NodeTypes[].FileTransferMethodId (integer) – File transfer id

  • [].NodeTypes[].Id (integer) – Id

  • [].NodeTypes[].MaxWalltime (integer) – Maximum of walltime

  • [].NodeTypes[].Name (string) – Name

  • [].NodeTypes[].NumberOfNodes (integer) – Number of nodes

  • [].NodeTypes[].Projects[].AccountingString (string) – Accounting string

  • [].NodeTypes[].Projects[].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • [].NodeTypes[].Projects[].CommandTemplates[].Description (string) – Description

  • [].NodeTypes[].Projects[].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • [].NodeTypes[].Projects[].CommandTemplates[].Id (integer) – Id

  • [].NodeTypes[].Projects[].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • [].NodeTypes[].Projects[].CommandTemplates[].IsGeneric (boolean) – Is generic

  • [].NodeTypes[].Projects[].CommandTemplates[].Name (string) – Name

  • [].NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • [].NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • [].NodeTypes[].Projects[].Description (string) – Description

  • [].NodeTypes[].Projects[].EndDate (string) – End date

  • [].NodeTypes[].Projects[].Id (integer) – Id

  • [].NodeTypes[].Projects[].Name (string) – Name

  • [].NodeTypes[].Projects[].StartDate (string) – Start date

  • [].NodeTypes[].Projects[].UsageType (integer)

  • [].NodeTypes[].Projects[].UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • [].NodeTypes[].QualityOfService (string) – Quality of service

  • [].NodeTypes[].Queue (string) – Queue

POST /heappe/ClusterInformation/RequestCommandTemplateParametersName

Get command template parameters name

Request JSON Object:

  • CommandTemplateId (integer) – Command template id

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

  • UserScriptPath (string) – User script path

Status Codes:
Response JSON Object:

  • [] (string)

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:
Response JSON Object:

  • CoresPerNode (integer) – Number of cores per node

  • Description (string) – Description

  • Id (integer) – Id

  • MaxWalltime (integer) – Maximum walltime

  • Name (string) – Name

  • NumberOfNodes (integer) – Number of nodes

  • NumberOfUsedNodes (integer) – Number of used nodes

  • Priority (integer) – Priority

  • TotalJobs (integer) – Total jobs number

POST /heappe/DataTransfer/RequestDataTransfer

Create Data Transfer

Request JSON Object:

  • IpAddress (string) – Ip address

  • Port (integer) – Port

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

Status Codes:
Response JSON Object:

  • NodeIPAddress (string) – Node ip address

  • NodePort (integer) – Node port

  • Port (integer) – Port

  • SubmittedTaskId (integer) – Submitted task id

POST /heappe/DataTransfer/CloseDataTransfer

CLose Data Transfer

Request JSON Object:

  • SessionCode (string) – Session code

  • UsedTransferMethod.NodeIPAddress (string) – Node ip address

  • UsedTransferMethod.NodePort (integer) – Node port

  • UsedTransferMethod.Port (integer) – Port

  • UsedTransferMethod.SubmittedTaskId (integer) – Submitted task id

Status Codes:
POST /heappe/DataTransfer/HttpGetToJobNode

Send HTTP GET to Job node

Request JSON Object:

  • HttpHeaders[].Name (string) – Name

  • HttpHeaders[].Value (string) – Value

  • HttpRequest (string) – Http request

  • NodeIPAddress (string) – Node ip address

  • NodePort (integer) – Node port (required)

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

Status Codes:
POST /heappe/DataTransfer/HttpPostToJobNode

Send HTTP POST to Job node

Request JSON Object:

  • HttpHeaders[].Name (string) – Name

  • HttpHeaders[].Value (string) – Value

  • HttpPayload (string) – Http payload

  • HttpRequest (string) – Http request

  • NodeIPAddress (string) – Node ip address

  • NodePort (integer) – Node port (required)

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

Status Codes:
POST /heappe/FileTransfer/RequestFileTransfer

Create file transfer tunnel

Request JSON Object:

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

Status Codes:
Response JSON Object:

  • Credentials.CipherType (integer)

  • Credentials.CredentialsAuthType (integer)

  • Credentials.Passphrase (string) – Passphrase

  • Credentials.Password (string) – Password

  • Credentials.PrivateKey (string) – Private key

  • Credentials.PrivateKeyCertificate (string) – Private key certificate

  • Credentials.PublicKey (string) – Public key

  • Credentials.Username (string) – User name

  • Id (integer) – Id

  • Port (integer) – Port

  • Protocol (integer)

  • ProxyConnection.Host (string) – Host

  • ProxyConnection.Id (integer) – Id

  • ProxyConnection.Password (string) – Password

  • ProxyConnection.Port (integer) – Port number

  • ProxyConnection.Type (integer)

  • ProxyConnection.Username (string) – Username

  • ServerHostname (string) – Server host name

  • SharedBasepath (string) – Shared base path

POST /heappe/FileTransfer/CloseFileTransfer

Close file transfer tunnel

Request JSON Object:

  • PublicKey (string) – Public key

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

Status Codes:
POST /heappe/FileTransfer/DownloadPartsOfJobFilesFromCluster

Download part of job files from Cluster

Request JSON Object:

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

  • TaskFileOffsets[].FileType (integer)

  • TaskFileOffsets[].Offset (integer) – Offset

  • TaskFileOffsets[].SubmittedTaskInfoId (integer) – Submitted task info id

Status Codes:
Response JSON Object:

  • [].Content (string) – Content

  • [].FileType (integer)

  • [].Offset (integer) – Offset

  • [].RelativePath (string) – Relative path

  • [].SubmittedTaskInfoId (integer) – Submitted task info id

GET /heappe/FileTransfer/ListChangedFilesForJob

Get all changes files during job execution

Query Parameters:

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – SubmittedJobInfo ID

Status Codes:
Response JSON Object:

  • [].FileName (string) – File name

  • [].LastModifiedDate (string) – Last modified at date

POST /heappe/FileTransfer/DownloadFileFromCluster

Download specific file from Cluster

Request JSON Object:

  • RelativeFilePath (string) – Relative file path on cluster

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

Status Codes:
POST /heappe/JobManagement/CreateJob

Create job specification

Request JSON Object:

  • JobSpecification.ClusterId (integer) – Cluster id

  • JobSpecification.EnvironmentVariables[].Name (string) – Name

  • JobSpecification.EnvironmentVariables[].Value (string) – Value

  • JobSpecification.FileTransferMethodId (integer) – File transfer method id

  • JobSpecification.IsExtraLong (boolean) – Is extra long

  • JobSpecification.Name (string) – Name

  • JobSpecification.NotificationEmail (string) – Notification email

  • JobSpecification.NotifyOnAbort (boolean) – Notify on abort

  • JobSpecification.NotifyOnFinish (boolean) – Notify on finish

  • JobSpecification.NotifyOnStart (boolean) – Notify on start

  • JobSpecification.PhoneNumber (string) – Phone number

  • JobSpecification.ProjectId (integer) – Project id

  • JobSpecification.SubProjectIdentifier (string) – Sub project identifier

  • JobSpecification.Tasks[].ClusterNodeTypeId (integer) – Cluster node type id

  • JobSpecification.Tasks[].ClusterTaskSubdirectory (string) – Cluster task subdirectory

  • JobSpecification.Tasks[].CommandTemplateId (integer) – Command template id

  • JobSpecification.Tasks[].CpuHyperThreading (boolean) – Cpu hyper threading

  • JobSpecification.Tasks[].DependsOn[] (any)

  • JobSpecification.Tasks[].EnvironmentVariables[].Name (string) – Name

  • JobSpecification.Tasks[].EnvironmentVariables[].Value (string) – Value

  • JobSpecification.Tasks[].IsExclusive (boolean) – Is exclusive

  • JobSpecification.Tasks[].IsRerunnable (boolean) – Is rerunnable

  • JobSpecification.Tasks[].JobArrays (string) – Job arrays

  • JobSpecification.Tasks[].LogFile (string) – Log file

  • JobSpecification.Tasks[].MaxCores (integer) – Maximum number of cores (required)

  • JobSpecification.Tasks[].MinCores (integer) – Minimum number of cores

  • JobSpecification.Tasks[].Name (string) – Name

  • JobSpecification.Tasks[].PlacementPolicy (string) – Placement policy

  • JobSpecification.Tasks[].Priority (integer)

  • JobSpecification.Tasks[].ProgressFile (string) – Progress file

  • JobSpecification.Tasks[].RequiredNodes[] (string)

  • JobSpecification.Tasks[].StandardErrorFile (string) – Standard error file

  • JobSpecification.Tasks[].StandardInputFile (string) – Standard input file

  • JobSpecification.Tasks[].StandardOutputFile (string) – Standard output file

  • JobSpecification.Tasks[].TaskParalizationParameters[].MPIProcesses (integer) – MPI processes

  • JobSpecification.Tasks[].TaskParalizationParameters[].MaxCores (integer) – Maximum cores

  • JobSpecification.Tasks[].TaskParalizationParameters[].OpenMPThreads (integer) – Open MP threads

  • JobSpecification.Tasks[].TemplateParameterValues[].CommandParameterIdentifier (string) – Command parameter identifier

  • JobSpecification.Tasks[].TemplateParameterValues[].ParameterValue (string) – Parameter value

  • JobSpecification.Tasks[].WalltimeLimit (integer) – Walltime limit

  • JobSpecification.WaitingLimit (integer) – Waiting limit

  • JobSpecification.WalltimeLimit (integer) – Walltime limit (read only)

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • CreationTime (string) – Creation time

  • EndTime (string) – End time

  • Id (integer) – Id

  • Name (string) – Name

  • StartTime (string) – Start time

  • State (integer)

  • SubProject (string) – Sub project

  • SubmitTime (string) – Submit time

  • Tasks[].AllocatedCoreIds[] (string)

  • Tasks[].AllocatedTime (number) – Allocated time

  • Tasks[].CpuHyperThreading (boolean) – Cpu hyper threading

  • Tasks[].EndTime (string) – End time

  • Tasks[].ErrorMessage (string) – Error message

  • Tasks[].Id (integer) – Id

  • Tasks[].Name (string) – Name

  • Tasks[].NodeType.Description (string) – Description

  • Tasks[].NodeType.Id (integer) – Id

  • Tasks[].NodeType.Name (string) – Name

  • Tasks[].NodeType.Project.AccountingString (string) – Accounting string

  • Tasks[].NodeType.Project.CommandTemplate.CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Tasks[].NodeType.Project.CommandTemplate.Description (string) – Description

  • Tasks[].NodeType.Project.CommandTemplate.ExtendedAllocationCommand (string) – Extended allocation command

  • Tasks[].NodeType.Project.CommandTemplate.Id (integer) – Id

  • Tasks[].NodeType.Project.CommandTemplate.IsEnabled (boolean) – Is enabled

  • Tasks[].NodeType.Project.CommandTemplate.IsGeneric (boolean) – Is generic

  • Tasks[].NodeType.Project.CommandTemplate.Name (string) – Name

  • Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Description (string) – Description

  • Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Identifier (string) – Identifier

  • Tasks[].NodeType.Project.Description (string) – Description

  • Tasks[].NodeType.Project.Id (integer) – Id

  • Tasks[].NodeType.Project.Name (string) – Name

  • Tasks[].Priority (integer)

  • Tasks[].StartTime (string) – Start time

  • Tasks[].State (integer)

  • TotalAllocatedTime (number) – Total allocation time

PUT /heappe/JobManagement/SubmitJob

Submit job

Request JSON Object:

  • CreatedJobInfoId (integer) – Created job info id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • CreationTime (string) – Creation time

  • EndTime (string) – End time

  • Id (integer) – Id

  • Name (string) – Name

  • StartTime (string) – Start time

  • State (integer)

  • SubProject (string) – Sub project

  • SubmitTime (string) – Submit time

  • Tasks[].AllocatedCoreIds[] (string)

  • Tasks[].AllocatedTime (number) – Allocated time

  • Tasks[].CpuHyperThreading (boolean) – Cpu hyper threading

  • Tasks[].EndTime (string) – End time

  • Tasks[].ErrorMessage (string) – Error message

  • Tasks[].Id (integer) – Id

  • Tasks[].Name (string) – Name

  • Tasks[].NodeType.Description (string) – Description

  • Tasks[].NodeType.Id (integer) – Id

  • Tasks[].NodeType.Name (string) – Name

  • Tasks[].NodeType.Project.AccountingString (string) – Accounting string

  • Tasks[].NodeType.Project.CommandTemplate.CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Tasks[].NodeType.Project.CommandTemplate.Description (string) – Description

  • Tasks[].NodeType.Project.CommandTemplate.ExtendedAllocationCommand (string) – Extended allocation command

  • Tasks[].NodeType.Project.CommandTemplate.Id (integer) – Id

  • Tasks[].NodeType.Project.CommandTemplate.IsEnabled (boolean) – Is enabled

  • Tasks[].NodeType.Project.CommandTemplate.IsGeneric (boolean) – Is generic

  • Tasks[].NodeType.Project.CommandTemplate.Name (string) – Name

  • Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Description (string) – Description

  • Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Identifier (string) – Identifier

  • Tasks[].NodeType.Project.Description (string) – Description

  • Tasks[].NodeType.Project.Id (integer) – Id

  • Tasks[].NodeType.Project.Name (string) – Name

  • Tasks[].Priority (integer)

  • Tasks[].StartTime (string) – Start time

  • Tasks[].State (integer)

  • TotalAllocatedTime (number) – Total allocation time

PUT /heappe/JobManagement/CancelJob

Cancel job

Request JSON Object:

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

Status Codes:
Response JSON Object:

  • CreationTime (string) – Creation time

  • EndTime (string) – End time

  • Id (integer) – Id

  • Name (string) – Name

  • StartTime (string) – Start time

  • State (integer)

  • SubProject (string) – Sub project

  • SubmitTime (string) – Submit time

  • Tasks[].AllocatedCoreIds[] (string)

  • Tasks[].AllocatedTime (number) – Allocated time

  • Tasks[].CpuHyperThreading (boolean) – Cpu hyper threading

  • Tasks[].EndTime (string) – End time

  • Tasks[].ErrorMessage (string) – Error message

  • Tasks[].Id (integer) – Id

  • Tasks[].Name (string) – Name

  • Tasks[].NodeType.Description (string) – Description

  • Tasks[].NodeType.Id (integer) – Id

  • Tasks[].NodeType.Name (string) – Name

  • Tasks[].NodeType.Project.AccountingString (string) – Accounting string

  • Tasks[].NodeType.Project.CommandTemplate.CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Tasks[].NodeType.Project.CommandTemplate.Description (string) – Description

  • Tasks[].NodeType.Project.CommandTemplate.ExtendedAllocationCommand (string) – Extended allocation command

  • Tasks[].NodeType.Project.CommandTemplate.Id (integer) – Id

  • Tasks[].NodeType.Project.CommandTemplate.IsEnabled (boolean) – Is enabled

  • Tasks[].NodeType.Project.CommandTemplate.IsGeneric (boolean) – Is generic

  • Tasks[].NodeType.Project.CommandTemplate.Name (string) – Name

  • Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Description (string) – Description

  • Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Identifier (string) – Identifier

  • Tasks[].NodeType.Project.Description (string) – Description

  • Tasks[].NodeType.Project.Id (integer) – Id

  • Tasks[].NodeType.Project.Name (string) – Name

  • Tasks[].Priority (integer)

  • Tasks[].StartTime (string) – Start time

  • Tasks[].State (integer)

  • TotalAllocatedTime (number) – Total allocation time

DELETE /heappe/JobManagement/DeleteJob

Delete job

Request JSON Object:

  • ArchiveLogs (boolean)

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

Status Codes:
GET /heappe/JobManagement/ListJobsForCurrentUser

Get all jobs for user

Query Parameters:

  • SessionCode (string) – Session code

  • JobStates (string) – Job states separated by coma; eg.: “1,2,8,32”, “Configuring,Submitted,Running,Failed”, “1,2,Running,Failed” etc.

Status Codes:
Response JSON Object:

  • [].CreationTime (string) – Creation time

  • [].EndTime (string) – End time

  • [].Id (integer) – Id

  • [].Name (string) – Name

  • [].StartTime (string) – Start time

  • [].State (integer)

  • [].SubProject (string) – Sub project

  • [].SubmitTime (string) – Submit time

  • [].Tasks[].AllocatedCoreIds[] (string)

  • [].Tasks[].AllocatedTime (number) – Allocated time

  • [].Tasks[].CpuHyperThreading (boolean) – Cpu hyper threading

  • [].Tasks[].EndTime (string) – End time

  • [].Tasks[].ErrorMessage (string) – Error message

  • [].Tasks[].Id (integer) – Id

  • [].Tasks[].Name (string) – Name

  • [].Tasks[].NodeType.Description (string) – Description

  • [].Tasks[].NodeType.Id (integer) – Id

  • [].Tasks[].NodeType.Name (string) – Name

  • [].Tasks[].NodeType.Project.AccountingString (string) – Accounting string

  • [].Tasks[].NodeType.Project.CommandTemplate.CreatedFromGenericTemplateId (integer) – Created from generic template id

  • [].Tasks[].NodeType.Project.CommandTemplate.Description (string) – Description

  • [].Tasks[].NodeType.Project.CommandTemplate.ExtendedAllocationCommand (string) – Extended allocation command

  • [].Tasks[].NodeType.Project.CommandTemplate.Id (integer) – Id

  • [].Tasks[].NodeType.Project.CommandTemplate.IsEnabled (boolean) – Is enabled

  • [].Tasks[].NodeType.Project.CommandTemplate.IsGeneric (boolean) – Is generic

  • [].Tasks[].NodeType.Project.CommandTemplate.Name (string) – Name

  • [].Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Description (string) – Description

  • [].Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Identifier (string) – Identifier

  • [].Tasks[].NodeType.Project.Description (string) – Description

  • [].Tasks[].NodeType.Project.Id (integer) – Id

  • [].Tasks[].NodeType.Project.Name (string) – Name

  • [].Tasks[].Priority (integer)

  • [].Tasks[].StartTime (string) – Start time

  • [].Tasks[].State (integer)

  • [].TotalAllocatedTime (number) – Total allocation time

GET /heappe/JobManagement/CurrentInfoForJob

Get current info for job

Query Parameters:

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – SubmittedJobInfo ID

Status Codes:
Response JSON Object:

  • CreationTime (string) – Creation time

  • EndTime (string) – End time

  • Id (integer) – Id

  • Name (string) – Name

  • StartTime (string) – Start time

  • State (integer)

  • SubProject (string) – Sub project

  • SubmitTime (string) – Submit time

  • Tasks[].AllocatedCoreIds[] (string)

  • Tasks[].AllocatedTime (number) – Allocated time

  • Tasks[].CpuHyperThreading (boolean) – Cpu hyper threading

  • Tasks[].EndTime (string) – End time

  • Tasks[].ErrorMessage (string) – Error message

  • Tasks[].Id (integer) – Id

  • Tasks[].Name (string) – Name

  • Tasks[].NodeType.Description (string) – Description

  • Tasks[].NodeType.Id (integer) – Id

  • Tasks[].NodeType.Name (string) – Name

  • Tasks[].NodeType.Project.AccountingString (string) – Accounting string

  • Tasks[].NodeType.Project.CommandTemplate.CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Tasks[].NodeType.Project.CommandTemplate.Description (string) – Description

  • Tasks[].NodeType.Project.CommandTemplate.ExtendedAllocationCommand (string) – Extended allocation command

  • Tasks[].NodeType.Project.CommandTemplate.Id (integer) – Id

  • Tasks[].NodeType.Project.CommandTemplate.IsEnabled (boolean) – Is enabled

  • Tasks[].NodeType.Project.CommandTemplate.IsGeneric (boolean) – Is generic

  • Tasks[].NodeType.Project.CommandTemplate.Name (string) – Name

  • Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Description (string) – Description

  • Tasks[].NodeType.Project.CommandTemplate.TemplateParameters[].Identifier (string) – Identifier

  • Tasks[].NodeType.Project.Description (string) – Description

  • Tasks[].NodeType.Project.Id (integer) – Id

  • Tasks[].NodeType.Project.Name (string) – Name

  • Tasks[].Priority (integer)

  • Tasks[].StartTime (string) – Start time

  • Tasks[].State (integer)

  • TotalAllocatedTime (number) – Total allocation time

POST /heappe/JobManagement/CopyJobDataToTemp

Copy job data to temp folder

Request JSON Object:

  • Path (string) – Path

  • SessionCode (string) – Session code

  • SubmittedJobInfoId (integer) – Subbmited job info id

Status Codes:
POST /heappe/JobManagement/CopyJobDataFromTemp

Copy job data from temp folder

Request JSON Object:

  • CreatedJobInfoId (integer) – Created job info id

  • SessionCode (string) – Session code

  • TempSessionCode (string) – Temp session code

Status Codes:
GET /heappe/JobManagement/AllocatedNodesIPs

Get Allocated Nodes IPs

Query Parameters:

  • SessionCode (string) – Session code

  • SubmittedTaskInfoId (integer) – SubmittedTaskInfo ID

Status Codes:
Response JSON Object:

  • [] (string)

GET /heappe/JobReporting/ListAdaptorUserGroups

Get user groups

Query Parameters:

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • Description (string) – Description

  • Id (integer) – Id

  • Name (string) – Name

  • Project.AccountingString (string) – Accounting string

  • Project.Description (string) – Description

  • Project.Id (integer) – Id

  • Project.Name (string) – Name

  • Project.TotalUsage (number) – Total usage

  • TotalUsage (number) – Total usage

  • UsageType (integer)

GET /heappe/JobReporting/UserResourceUsageReport

Get resource usage report for user

Query Parameters:

  • UserId (integer) – User ID

  • StartTime (string) – StartTime

  • EndTime (string) – EndTime

  • SubProjects (array) – SubProjects

  • SessionCode (string) – SessionCode

Status Codes:
Response JSON Object:

  • [].AccountingString (string) – Accounting string

  • [].Clusters[].ClusterNodeTypes[].Id (integer) – Id

  • [].Clusters[].ClusterNodeTypes[].Jobs[].Id (integer) – Id

  • [].Clusters[].ClusterNodeTypes[].Jobs[].Name (string) – Name

  • [].Clusters[].ClusterNodeTypes[].Jobs[].SubProject (string) – Sub project

  • [].Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].Id (integer) – Id

  • [].Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].Name (string) – Name

  • [].Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].Usage (number) – Usage

  • [].Clusters[].ClusterNodeTypes[].Name (string) – Name

  • [].Clusters[].ClusterNodeTypes[].TotalUsage (number) – Total usage

  • [].Clusters[].Id (integer) – Id

  • [].Clusters[].Name (string) – Name

  • [].Clusters[].TotalUsage (number) – Total usage

  • [].Id (integer) – Id

  • [].Name (string) – Name

  • [].TotalUsage (number) – Total usage

  • [].UsageType (integer)

GET /heappe/JobReporting/UserGroupResourceUsageReport

Get resource usage for user group

Query Parameters:

  • GroupId (integer) – Group ID

  • StartTime (string) – StartTime

  • EndTime (string) – EndTime

  • SubProjects (array) – SubProjects

  • SessionCode (string) – SessionCode

Status Codes:
Response JSON Object:

  • AccountingString (string) – Accounting string

  • Clusters[].ClusterNodeTypes[].Id (integer) – Id

  • Clusters[].ClusterNodeTypes[].Jobs[].Id (integer) – Id

  • Clusters[].ClusterNodeTypes[].Jobs[].Name (string) – Name

  • Clusters[].ClusterNodeTypes[].Jobs[].SubProject (string) – Sub project

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].Id (integer) – Id

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].Name (string) – Name

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].Usage (number) – Usage

  • Clusters[].ClusterNodeTypes[].Name (string) – Name

  • Clusters[].ClusterNodeTypes[].TotalUsage (number) – Total usage

  • Clusters[].Id (integer) – Id

  • Clusters[].Name (string) – Name

  • Clusters[].TotalUsage (number) – Total usage

  • Id (integer) – Id

  • Name (string) – Name

  • TotalUsage (number) – Total usage

  • UsageType (integer)

GET /heappe/JobReporting/ResourceUsageReportForJob

Get resource usage for executed job

Query Parameters:

  • SessionCode (string) – Session code

  • JobId (integer) – Job ID

Status Codes:
Response JSON Object:

  • AccountingString (string) – Accounting string

  • Clusters[].ClusterNodeTypes[].Description (string) – Description

  • Clusters[].ClusterNodeTypes[].Id (integer) – Id

  • Clusters[].ClusterNodeTypes[].Jobs[].Id (integer) – Id

  • Clusters[].ClusterNodeTypes[].Jobs[].Name (string) – Name

  • Clusters[].ClusterNodeTypes[].Jobs[].State (integer)

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].CommandTemplateId (integer) – Command template id

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].EndTime (string) – End time

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].Id (integer) – Id

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].Name (string) – Name

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].StartTime (string) – Start time

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].State (integer)

  • Clusters[].ClusterNodeTypes[].Jobs[].Tasks[].Usage (number) – Usage

  • Clusters[].ClusterNodeTypes[].Name (string) – Name

  • Clusters[].ClusterNodeTypes[].TotalUsage (number) – Total usage

  • Clusters[].Description (string) – Description (required)

  • Clusters[].Id (integer) – Id

  • Clusters[].Name (string) – Name

  • Clusters[].TotalUsage (number) – Total usage

  • Description (string) – Description

  • Id (integer) – Id

  • Name (string) – Name

  • TotalUsage (number) – Total usage

GET /heappe/JobReporting/JobsStateAgregationReport

Get job state aggregation report

Query Parameters:

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • [].Count (integer) – Count

  • [].JobStateId (integer)

  • [].JobStateName (string) – Job state name

GET /heappe/Management/InstanceInformation

Get HEAppE Information

Query Parameters:

  • SessionCode (string) – SessionCode

Status Codes:
Response JSON Object:

  • DeployedIPAddress (string) – Deployed IP address

  • DeploymentType (integer)

  • Description (string) – Description

  • Name (string) – Name

  • Port (integer) – Port

  • Projects[].AccountingString (string) – Accounting string

  • Projects[].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Projects[].CommandTemplates[].Description (string) – Description

  • Projects[].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • Projects[].CommandTemplates[].Id (integer) – Id

  • Projects[].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • Projects[].CommandTemplates[].IsGeneric (boolean) – Is generic

  • Projects[].CommandTemplates[].Name (string) – Name

  • Projects[].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • Projects[].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • Projects[].Contacts[] (string)

  • Projects[].Description (string) – Description

  • Projects[].EndDate (string) – End date

  • Projects[].Id (integer) – Id

  • Projects[].Name (string) – Name

  • Projects[].PrimaryInvestigatorContact (string) – Primary investigator contact

  • Projects[].StartDate (string) – Start date

  • ResourceAllocationTypes[] (integer)

  • URL (string) – URL

  • URLPostfix (string) – URL Postfix

  • Version (string) – Version

GET /heappe/Management/VersionInformation

Get HEAppE Version Information

Query Parameters:

  • SessionCode (string) – SessionCode

Status Codes:
Response JSON Object:

  • Description (string) – Description

  • Name (string) – Name

  • Version (string) – Version

GET /heappe/Management/CommandTemplate

List Command Template

Query Parameters:

  • SessionCode (string)

  • Id (integer)

Status Codes:
Response JSON Object:

  • ClusterNodeTypeId (integer) – Cluster node type id

  • CommandParameters (string) – Command parameters

  • CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Description (string) – Description

  • ExecutableFile (string) – Executable file

  • ExtendedAllocationCommand (string) – Extended allocation command

  • Id (integer) – Id

  • IsEnabled (boolean) – Is enabled

  • IsGeneric (boolean) – Is generic

  • Name (string) – Name

  • PreparationScript (string) – Preparation script

  • ProjectId (integer) – Project id

  • TemplateParameters[].Description (string) – Description

  • TemplateParameters[].Id (integer) – Id

  • TemplateParameters[].Identifier (string) – Identifier

  • TemplateParameters[].Query (string) – Query

POST /heappe/Management/CommandTemplate

Create Static Command Template

Request JSON Object:

  • ClusterNodeTypeId (integer) – Cluster node type id

  • Description (string) – Description

  • ExecutableFile (string) – Executable file

  • ExtendedAllocationCommand (string) – Extended allocation command

  • Name (string) – Name

  • PreparationScript (string) – Preparation script

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

  • TemplateParameters[].Description (string) – Description

  • TemplateParameters[].Identifier (string) – Identifier

  • TemplateParameters[].Query (string) – Query

Status Codes:
Response JSON Object:

  • ClusterNodeTypeId (integer) – Cluster node type id

  • CommandParameters (string) – Command parameters

  • CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Description (string) – Description

  • ExecutableFile (string) – Executable file

  • ExtendedAllocationCommand (string) – Extended allocation command

  • Id (integer) – Id

  • IsEnabled (boolean) – Is enabled

  • IsGeneric (boolean) – Is generic

  • Name (string) – Name

  • PreparationScript (string) – Preparation script

  • ProjectId (integer) – Project id

  • TemplateParameters[].Description (string) – Description

  • TemplateParameters[].Id (integer) – Id

  • TemplateParameters[].Identifier (string) – Identifier

  • TemplateParameters[].Query (string) – Query

PUT /heappe/Management/CommandTemplate

Modify Static Command Template

Request JSON Object:

  • ClusterNodeTypeId (integer) – Cluster node type id

  • Description (string) – Description

  • ExecutableFile (string) – Executable file

  • ExtendedAllocationCommand (string) – Extended allocation command

  • Id (integer) – Id

  • IsEnabled (boolean) – Is enabled

  • Name (string) – Name

  • PreparationScript (string) – Preparation script

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • ClusterNodeTypeId (integer) – Cluster node type id

  • CommandParameters (string) – Command parameters

  • CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Description (string) – Description

  • ExecutableFile (string) – Executable file

  • ExtendedAllocationCommand (string) – Extended allocation command

  • Id (integer) – Id

  • IsEnabled (boolean) – Is enabled

  • IsGeneric (boolean) – Is generic

  • Name (string) – Name

  • PreparationScript (string) – Preparation script

  • ProjectId (integer) – Project id

  • TemplateParameters[].Description (string) – Description

  • TemplateParameters[].Id (integer) – Id

  • TemplateParameters[].Identifier (string) – Identifier

  • TemplateParameters[].Query (string) – Query

GET /heappe/Management/CommandTemplates

List Command Templates

Query Parameters:

  • SessionCode (string)

  • ProjectId (integer)

Status Codes:
Response JSON Object:

  • [].ClusterNodeTypeId (integer) – Cluster node type id

  • [].CommandParameters (string) – Command parameters

  • [].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • [].Description (string) – Description

  • [].ExecutableFile (string) – Executable file

  • [].ExtendedAllocationCommand (string) – Extended allocation command

  • [].Id (integer) – Id

  • [].IsEnabled (boolean) – Is enabled

  • [].IsGeneric (boolean) – Is generic

  • [].Name (string) – Name

  • [].PreparationScript (string) – Preparation script

  • [].ProjectId (integer) – Project id

  • [].TemplateParameters[].Description (string) – Description

  • [].TemplateParameters[].Id (integer) – Id

  • [].TemplateParameters[].Identifier (string) – Identifier

  • [].TemplateParameters[].Query (string) – Query

POST /heappe/Management/CommandTemplateFromGeneric

Create Command Template from Generic Command Template

Request JSON Object:

  • Description (string) – Description

  • ExecutableFile (string) – Executable file

  • ExtendedAllocationCommand (string) – Extended allocation command

  • GenericCommandTemplateId (integer) – Generic command template id

  • Name (string) – Name

  • PreparationScript (string) – Preparation script

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Description (string) – Description

  • ExtendedAllocationCommand (string) – Extended allocation command

  • Id (integer) – Id

  • IsEnabled (boolean) – Is enabled

  • IsGeneric (boolean) – Is generic

  • Name (string) – Name

  • TemplateParameters[].Description (string) – Description

  • TemplateParameters[].Identifier (string) – Identifier

PUT /heappe/Management/CommandTemplateFromGeneric

Modify Command Template based on Generic Command Template

Request JSON Object:

  • CommandTemplateId (integer) – Command template id

  • Description (string) – Description

  • ExecutableFile (string) – Executable file

  • ExtendedAllocationCommand (string) – Extended allocation command

  • Name (string) – Name

  • PreparationScript (string) – Preparation script

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Description (string) – Description

  • ExtendedAllocationCommand (string) – Extended allocation command

  • Id (integer) – Id

  • IsEnabled (boolean) – Is enabled

  • IsGeneric (boolean) – Is generic

  • Name (string) – Name

  • TemplateParameters[].Description (string) – Description

  • TemplateParameters[].Identifier (string) – Identifier

DELETE /heappe/Management/RemoveCommandTemplate

Remove Command Template

Request JSON Object:

  • CommandTemplateId (integer) – Command template id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/CommandTemplateParameter

Get CommandTemplateParameter by id

Query Parameters:

  • Id (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • Description (string) – Description

  • Id (integer) – Id

  • Identifier (string) – Identifier

  • Query (string) – Query

POST /heappe/Management/CommandTemplateParameter

Create Static Command Template

Request JSON Object:

  • CommandTemplateId (integer) – Command template id

  • Description (string) – Description

  • Identifier (string) – Identifier

  • Query (string) – Query

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • Description (string) – Description

  • Id (integer) – Id

  • Identifier (string) – Identifier

  • Query (string) – Query

PUT /heappe/Management/CommandTemplateParameter

Modify Static Command Template

Request JSON Object:

  • Description (string) – Description

  • Id (integer) – Id

  • Identifier (string) – Identifier

  • Query (string) – Query

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • Description (string) – Description

  • Id (integer) – Id

  • Identifier (string) – Identifier

  • Query (string) – Query

DELETE /heappe/Management/CommandTemplateParameter

Remove Static Command Template

Request JSON Object:

  • Id (integer) – Id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/ProjectsByAccountingStrings

Get project by accounting string

Query Parameters:

  • AccountingString (array)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • [].AccountingString (string) – Accounting string

  • [].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • [].CommandTemplates[].Description (string) – Description

  • [].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • [].CommandTemplates[].Id (integer) – Id

  • [].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • [].CommandTemplates[].IsGeneric (boolean) – Is generic

  • [].CommandTemplates[].Name (string) – Name

  • [].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • [].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • [].Description (string) – Description

  • [].EndDate (string) – End date

  • [].Id (integer) – Id

  • [].Name (string) – Name

  • [].StartDate (string) – Start date

  • [].UsageType (integer)

  • [].UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

GET /heappe/Management/Project

Get Project by id

Query Parameters:

  • Id (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • AccountingString (string) – Accounting string

  • CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • CommandTemplates[].Description (string) – Description

  • CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • CommandTemplates[].Id (integer) – Id

  • CommandTemplates[].IsEnabled (boolean) – Is enabled

  • CommandTemplates[].IsGeneric (boolean) – Is generic

  • CommandTemplates[].Name (string) – Name

  • CommandTemplates[].TemplateParameters[].Description (string) – Description

  • CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • Description (string) – Description

  • EndDate (string) – End date

  • Id (integer) – Id

  • Name (string) – Name

  • StartDate (string) – Start date

  • UsageType (integer)

  • UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

POST /heappe/Management/Project

Create project

Request JSON Object:

  • AccountingString (string) – Accounting string

  • Description (string) – Description

  • EndDate (string) – End date

  • Name (string) – Name

  • PIEmail (string) – PIEmail

  • SessionCode (string) – Session code

  • StartDate (string) – Start date

  • UsageType (integer)

  • UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

Status Codes:
Response JSON Object:

  • AccountingString (string) – Accounting string

  • CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • CommandTemplates[].Description (string) – Description

  • CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • CommandTemplates[].Id (integer) – Id

  • CommandTemplates[].IsEnabled (boolean) – Is enabled

  • CommandTemplates[].IsGeneric (boolean) – Is generic

  • CommandTemplates[].Name (string) – Name

  • CommandTemplates[].TemplateParameters[].Description (string) – Description

  • CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • Description (string) – Description

  • EndDate (string) – End date

  • Id (integer) – Id

  • Name (string) – Name

  • StartDate (string) – Start date

  • UsageType (integer)

  • UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

PUT /heappe/Management/Project

Modify project

Request JSON Object:

  • Description (string) – Description

  • EndDate (string) – End date

  • Id (integer) – Id

  • Name (string) – Name

  • SessionCode (string) – Session code

  • StartDate (string) – Start date

  • UsageType (integer)

  • UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

Status Codes:
Response JSON Object:

  • AccountingString (string) – Accounting string

  • CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • CommandTemplates[].Description (string) – Description

  • CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • CommandTemplates[].Id (integer) – Id

  • CommandTemplates[].IsEnabled (boolean) – Is enabled

  • CommandTemplates[].IsGeneric (boolean) – Is generic

  • CommandTemplates[].Name (string) – Name

  • CommandTemplates[].TemplateParameters[].Description (string) – Description

  • CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • Description (string) – Description

  • EndDate (string) – End date

  • Id (integer) – Id

  • Name (string) – Name

  • StartDate (string) – Start date

  • UsageType (integer)

  • UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

DELETE /heappe/Management/Project

Remove project

Request JSON Object:

  • Id (integer) – Id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/ProjectAssignmentToCluster

Get ProjectAssignmentToCluster by id

Query Parameters:

  • ProjectId (integer)

  • ClusterId (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • ClusterId (integer) – Id

  • CreatedAt (string) – Created at

  • LocalBasepath (string) – Local base path

  • ModifiedAt (string) – Modified at

  • ProjectId (integer) – Project id

POST /heappe/Management/ProjectAssignmentToCluster

Assign project to the cluster

Request JSON Object:

  • ClusterId (integer) – Cluster id

  • LocalBasepath (string) – Local base path

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • ClusterId (integer) – Id

  • CreatedAt (string) – Created at

  • LocalBasepath (string) – Local base path

  • ModifiedAt (string) – Modified at

  • ProjectId (integer) – Project id

PUT /heappe/Management/ProjectAssignmentToCluster

Modify project assignment to the cluster

Request JSON Object:

  • ClusterId (integer) – Cluster id

  • LocalBasepath (string) – Local base path

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • ClusterId (integer) – Id

  • CreatedAt (string) – Created at

  • LocalBasepath (string) – Local base path

  • ModifiedAt (string) – Modified at

  • ProjectId (integer) – Project id

DELETE /heappe/Management/ProjectAssignmentToCluster

Remove project assignment to the cluster

Request JSON Object:

  • ClusterId (integer) – Cluster id

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/Cluster

Get Cluster by id

Query Parameters:

  • Id (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • ConnectionProtocol (integer)

  • Description (string) – Description

  • DomainName (string) – DomainName

  • Id (integer) – Id

  • MasterNodeName (string) – Master node name

  • Name (string) – Name

  • NodeTypes[].Accounting[].CreatedAt (string) – Created at date

  • NodeTypes[].Accounting[].Formula (string) – Formula

  • NodeTypes[].Accounting[].Id (integer) – Id

  • NodeTypes[].Accounting[].ModifiedAt (string) – Modified at date

  • NodeTypes[].Accounting[].ValidityFrom (string) – Validity from date

  • NodeTypes[].Accounting[].ValidityTo (string) – Validity to date

  • NodeTypes[].ClusterAllocationName (string) – Cluster allocation name

  • NodeTypes[].ClusterNodeTypeAggregation.AllocationType (string) – Allocation type

  • NodeTypes[].ClusterNodeTypeAggregation.Description (string) – Description

  • NodeTypes[].ClusterNodeTypeAggregation.Id (integer) – Id

  • NodeTypes[].ClusterNodeTypeAggregation.Name (string) – Name

  • NodeTypes[].ClusterNodeTypeAggregation.ValidityFrom (string) – Valid from

  • NodeTypes[].ClusterNodeTypeAggregation.ValidityTo (string) – Valid to

  • NodeTypes[].CoresPerNode (integer) – Number of cores per node

  • NodeTypes[].Description (string) – Description

  • NodeTypes[].FileTransferMethodId (integer) – File transfer id

  • NodeTypes[].Id (integer) – Id

  • NodeTypes[].MaxWalltime (integer) – Maximum of walltime

  • NodeTypes[].Name (string) – Name

  • NodeTypes[].NumberOfNodes (integer) – Number of nodes

  • NodeTypes[].Projects[].AccountingString (string) – Accounting string

  • NodeTypes[].Projects[].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • NodeTypes[].Projects[].CommandTemplates[].Description (string) – Description

  • NodeTypes[].Projects[].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • NodeTypes[].Projects[].CommandTemplates[].Id (integer) – Id

  • NodeTypes[].Projects[].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • NodeTypes[].Projects[].CommandTemplates[].IsGeneric (boolean) – Is generic

  • NodeTypes[].Projects[].CommandTemplates[].Name (string) – Name

  • NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • NodeTypes[].Projects[].Description (string) – Description

  • NodeTypes[].Projects[].EndDate (string) – End date

  • NodeTypes[].Projects[].Id (integer) – Id

  • NodeTypes[].Projects[].Name (string) – Name

  • NodeTypes[].Projects[].StartDate (string) – Start date

  • NodeTypes[].Projects[].UsageType (integer)

  • NodeTypes[].Projects[].UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • NodeTypes[].QualityOfService (string) – Quality of service

  • NodeTypes[].Queue (string) – Queue

  • Port (integer) – SSH port

  • ProxyConnection.Host (string) – Host

  • ProxyConnection.Id (integer) – Id

  • ProxyConnection.Password (string) – Password

  • ProxyConnection.Port (integer) – Port number

  • ProxyConnection.Type (integer)

  • ProxyConnection.Username (string) – Username

  • SchedulerType (integer)

  • TimeZone (string) – Time zone

  • UpdateJobStateByServiceAccount (boolean) – Update Job State By ServiceAccount

POST /heappe/Management/Cluster

Create Cluster

Request JSON Object:

  • ConnectionProtocol (integer)

  • Description (string) – Description

  • DomainName (string) – Domain name

  • MasterNodeName (string) – Master node name

  • Name (string) – Name

  • Port (integer) – Port

  • ProxyConnectionId (integer) – Proxy connection id

  • SchedulerType (integer)

  • SessionCode (string) – Session code

  • TimeZone (string) – Time zone

  • UpdateJobStateByServiceAccount (boolean) – Update job state by service account

Status Codes:
Response JSON Object:

  • ConnectionProtocol (integer)

  • Description (string) – Description

  • DomainName (string) – DomainName

  • Id (integer) – Id

  • MasterNodeName (string) – Master node name

  • Name (string) – Name

  • NodeTypes[].Accounting[].CreatedAt (string) – Created at date

  • NodeTypes[].Accounting[].Formula (string) – Formula

  • NodeTypes[].Accounting[].Id (integer) – Id

  • NodeTypes[].Accounting[].ModifiedAt (string) – Modified at date

  • NodeTypes[].Accounting[].ValidityFrom (string) – Validity from date

  • NodeTypes[].Accounting[].ValidityTo (string) – Validity to date

  • NodeTypes[].ClusterAllocationName (string) – Cluster allocation name

  • NodeTypes[].ClusterNodeTypeAggregation.AllocationType (string) – Allocation type

  • NodeTypes[].ClusterNodeTypeAggregation.Description (string) – Description

  • NodeTypes[].ClusterNodeTypeAggregation.Id (integer) – Id

  • NodeTypes[].ClusterNodeTypeAggregation.Name (string) – Name

  • NodeTypes[].ClusterNodeTypeAggregation.ValidityFrom (string) – Valid from

  • NodeTypes[].ClusterNodeTypeAggregation.ValidityTo (string) – Valid to

  • NodeTypes[].CoresPerNode (integer) – Number of cores per node

  • NodeTypes[].Description (string) – Description

  • NodeTypes[].FileTransferMethodId (integer) – File transfer id

  • NodeTypes[].Id (integer) – Id

  • NodeTypes[].MaxWalltime (integer) – Maximum of walltime

  • NodeTypes[].Name (string) – Name

  • NodeTypes[].NumberOfNodes (integer) – Number of nodes

  • NodeTypes[].Projects[].AccountingString (string) – Accounting string

  • NodeTypes[].Projects[].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • NodeTypes[].Projects[].CommandTemplates[].Description (string) – Description

  • NodeTypes[].Projects[].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • NodeTypes[].Projects[].CommandTemplates[].Id (integer) – Id

  • NodeTypes[].Projects[].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • NodeTypes[].Projects[].CommandTemplates[].IsGeneric (boolean) – Is generic

  • NodeTypes[].Projects[].CommandTemplates[].Name (string) – Name

  • NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • NodeTypes[].Projects[].Description (string) – Description

  • NodeTypes[].Projects[].EndDate (string) – End date

  • NodeTypes[].Projects[].Id (integer) – Id

  • NodeTypes[].Projects[].Name (string) – Name

  • NodeTypes[].Projects[].StartDate (string) – Start date

  • NodeTypes[].Projects[].UsageType (integer)

  • NodeTypes[].Projects[].UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • NodeTypes[].QualityOfService (string) – Quality of service

  • NodeTypes[].Queue (string) – Queue

  • Port (integer) – SSH port

  • ProxyConnection.Host (string) – Host

  • ProxyConnection.Id (integer) – Id

  • ProxyConnection.Password (string) – Password

  • ProxyConnection.Port (integer) – Port number

  • ProxyConnection.Type (integer)

  • ProxyConnection.Username (string) – Username

  • SchedulerType (integer)

  • TimeZone (string) – Time zone

  • UpdateJobStateByServiceAccount (boolean) – Update Job State By ServiceAccount

PUT /heappe/Management/Cluster

Update Cluster

Request JSON Object:

  • ConnectionProtocol (integer)

  • Description (string) – Description

  • DomainName (string) – Domain name

  • Id (integer) – Id

  • MasterNodeName (string) – Master node name

  • Name (string) – Name

  • Port (integer) – Port

  • ProxyConnectionId (integer) – Proxy connection id

  • SchedulerType (integer)

  • SessionCode (string) – Session code

  • TimeZone (string) – Time zone

  • UpdateJobStateByServiceAccount (boolean) – Update job state by service account

Status Codes:
Response JSON Object:

  • ConnectionProtocol (integer)

  • Description (string) – Description

  • DomainName (string) – DomainName

  • Id (integer) – Id

  • MasterNodeName (string) – Master node name

  • Name (string) – Name

  • NodeTypes[].Accounting[].CreatedAt (string) – Created at date

  • NodeTypes[].Accounting[].Formula (string) – Formula

  • NodeTypes[].Accounting[].Id (integer) – Id

  • NodeTypes[].Accounting[].ModifiedAt (string) – Modified at date

  • NodeTypes[].Accounting[].ValidityFrom (string) – Validity from date

  • NodeTypes[].Accounting[].ValidityTo (string) – Validity to date

  • NodeTypes[].ClusterAllocationName (string) – Cluster allocation name

  • NodeTypes[].ClusterNodeTypeAggregation.AllocationType (string) – Allocation type

  • NodeTypes[].ClusterNodeTypeAggregation.Description (string) – Description

  • NodeTypes[].ClusterNodeTypeAggregation.Id (integer) – Id

  • NodeTypes[].ClusterNodeTypeAggregation.Name (string) – Name

  • NodeTypes[].ClusterNodeTypeAggregation.ValidityFrom (string) – Valid from

  • NodeTypes[].ClusterNodeTypeAggregation.ValidityTo (string) – Valid to

  • NodeTypes[].CoresPerNode (integer) – Number of cores per node

  • NodeTypes[].Description (string) – Description

  • NodeTypes[].FileTransferMethodId (integer) – File transfer id

  • NodeTypes[].Id (integer) – Id

  • NodeTypes[].MaxWalltime (integer) – Maximum of walltime

  • NodeTypes[].Name (string) – Name

  • NodeTypes[].NumberOfNodes (integer) – Number of nodes

  • NodeTypes[].Projects[].AccountingString (string) – Accounting string

  • NodeTypes[].Projects[].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • NodeTypes[].Projects[].CommandTemplates[].Description (string) – Description

  • NodeTypes[].Projects[].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • NodeTypes[].Projects[].CommandTemplates[].Id (integer) – Id

  • NodeTypes[].Projects[].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • NodeTypes[].Projects[].CommandTemplates[].IsGeneric (boolean) – Is generic

  • NodeTypes[].Projects[].CommandTemplates[].Name (string) – Name

  • NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • NodeTypes[].Projects[].Description (string) – Description

  • NodeTypes[].Projects[].EndDate (string) – End date

  • NodeTypes[].Projects[].Id (integer) – Id

  • NodeTypes[].Projects[].Name (string) – Name

  • NodeTypes[].Projects[].StartDate (string) – Start date

  • NodeTypes[].Projects[].UsageType (integer)

  • NodeTypes[].Projects[].UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • NodeTypes[].QualityOfService (string) – Quality of service

  • NodeTypes[].Queue (string) – Queue

  • Port (integer) – SSH port

  • ProxyConnection.Host (string) – Host

  • ProxyConnection.Id (integer) – Id

  • ProxyConnection.Password (string) – Password

  • ProxyConnection.Port (integer) – Port number

  • ProxyConnection.Type (integer)

  • ProxyConnection.Username (string) – Username

  • SchedulerType (integer)

  • TimeZone (string) – Time zone

  • UpdateJobStateByServiceAccount (boolean) – Update Job State By ServiceAccount

DELETE /heappe/Management/Cluster

Remove Cluster

Request JSON Object:

  • Id (integer) – Id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/Clusters

Get all clusters

Query Parameters:

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • [].ConnectionProtocol (integer)

  • [].Description (string) – Description

  • [].DomainName (string) – DomainName

  • [].Id (integer) – Id

  • [].MasterNodeName (string) – Master node name

  • [].Name (string) – Name

  • [].NodeTypes[].Accounting[].CreatedAt (string) – Created at date

  • [].NodeTypes[].Accounting[].Formula (string) – Formula

  • [].NodeTypes[].Accounting[].Id (integer) – Id

  • [].NodeTypes[].Accounting[].ModifiedAt (string) – Modified at date

  • [].NodeTypes[].Accounting[].ValidityFrom (string) – Validity from date

  • [].NodeTypes[].Accounting[].ValidityTo (string) – Validity to date

  • [].NodeTypes[].ClusterAllocationName (string) – Cluster allocation name

  • [].NodeTypes[].ClusterNodeTypeAggregation.AllocationType (string) – Allocation type

  • [].NodeTypes[].ClusterNodeTypeAggregation.Description (string) – Description

  • [].NodeTypes[].ClusterNodeTypeAggregation.Id (integer) – Id

  • [].NodeTypes[].ClusterNodeTypeAggregation.Name (string) – Name

  • [].NodeTypes[].ClusterNodeTypeAggregation.ValidityFrom (string) – Valid from

  • [].NodeTypes[].ClusterNodeTypeAggregation.ValidityTo (string) – Valid to

  • [].NodeTypes[].CoresPerNode (integer) – Number of cores per node

  • [].NodeTypes[].Description (string) – Description

  • [].NodeTypes[].FileTransferMethodId (integer) – File transfer id

  • [].NodeTypes[].Id (integer) – Id

  • [].NodeTypes[].MaxWalltime (integer) – Maximum of walltime

  • [].NodeTypes[].Name (string) – Name

  • [].NodeTypes[].NumberOfNodes (integer) – Number of nodes

  • [].NodeTypes[].Projects[].AccountingString (string) – Accounting string

  • [].NodeTypes[].Projects[].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • [].NodeTypes[].Projects[].CommandTemplates[].Description (string) – Description

  • [].NodeTypes[].Projects[].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • [].NodeTypes[].Projects[].CommandTemplates[].Id (integer) – Id

  • [].NodeTypes[].Projects[].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • [].NodeTypes[].Projects[].CommandTemplates[].IsGeneric (boolean) – Is generic

  • [].NodeTypes[].Projects[].CommandTemplates[].Name (string) – Name

  • [].NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • [].NodeTypes[].Projects[].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • [].NodeTypes[].Projects[].Description (string) – Description

  • [].NodeTypes[].Projects[].EndDate (string) – End date

  • [].NodeTypes[].Projects[].Id (integer) – Id

  • [].NodeTypes[].Projects[].Name (string) – Name

  • [].NodeTypes[].Projects[].StartDate (string) – Start date

  • [].NodeTypes[].Projects[].UsageType (integer)

  • [].NodeTypes[].Projects[].UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • [].NodeTypes[].QualityOfService (string) – Quality of service

  • [].NodeTypes[].Queue (string) – Queue

  • [].Port (integer) – SSH port

  • [].ProxyConnection.Host (string) – Host

  • [].ProxyConnection.Id (integer) – Id

  • [].ProxyConnection.Password (string) – Password

  • [].ProxyConnection.Port (integer) – Port number

  • [].ProxyConnection.Type (integer)

  • [].ProxyConnection.Username (string) – Username

  • [].SchedulerType (integer)

  • [].TimeZone (string) – Time zone

  • [].UpdateJobStateByServiceAccount (boolean) – Update Job State By ServiceAccount

GET /heappe/Management/ClusterNodeType

Get ClusterNodeType by id

Query Parameters:

  • Id (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • Accounting[].CreatedAt (string) – Created at date

  • Accounting[].Formula (string) – Formula

  • Accounting[].Id (integer) – Id

  • Accounting[].ModifiedAt (string) – Modified at date

  • Accounting[].ValidityFrom (string) – Validity from date

  • Accounting[].ValidityTo (string) – Validity to date

  • ClusterAllocationName (string) – Cluster allocation name

  • ClusterNodeTypeAggregation.AllocationType (string) – Allocation type

  • ClusterNodeTypeAggregation.Description (string) – Description

  • ClusterNodeTypeAggregation.Id (integer) – Id

  • ClusterNodeTypeAggregation.Name (string) – Name

  • ClusterNodeTypeAggregation.ValidityFrom (string) – Valid from

  • ClusterNodeTypeAggregation.ValidityTo (string) – Valid to

  • CoresPerNode (integer) – Number of cores per node

  • Description (string) – Description

  • FileTransferMethodId (integer) – File transfer id

  • Id (integer) – Id

  • MaxWalltime (integer) – Maximum of walltime

  • Name (string) – Name

  • NumberOfNodes (integer) – Number of nodes

  • Projects[].AccountingString (string) – Accounting string

  • Projects[].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Projects[].CommandTemplates[].Description (string) – Description

  • Projects[].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • Projects[].CommandTemplates[].Id (integer) – Id

  • Projects[].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • Projects[].CommandTemplates[].IsGeneric (boolean) – Is generic

  • Projects[].CommandTemplates[].Name (string) – Name

  • Projects[].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • Projects[].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • Projects[].Description (string) – Description

  • Projects[].EndDate (string) – End date

  • Projects[].Id (integer) – Id

  • Projects[].Name (string) – Name

  • Projects[].StartDate (string) – Start date

  • Projects[].UsageType (integer)

  • Projects[].UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • QualityOfService (string) – Quality of service

  • Queue (string) – Queue

POST /heappe/Management/ClusterNodeType

Create ClusterNodeType

Request JSON Object:

  • ClusterAllocationName (string) – Cluster allocation name

  • ClusterId (integer) – Cluster id

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • CoresPerNode (integer) – Number of cores per node

  • Description (string) – Description

  • FileTransferMethodId (integer) – File transfer method id

  • MaxWalltime (integer) – Maximum walltime

  • Name (string) – Name

  • NumberOfNodes (integer) – Number of nodes

  • QualityOfService (string) – Quality of service

  • Queue (string) – Queue

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • Accounting[].CreatedAt (string) – Created at date

  • Accounting[].Formula (string) – Formula

  • Accounting[].Id (integer) – Id

  • Accounting[].ModifiedAt (string) – Modified at date

  • Accounting[].ValidityFrom (string) – Validity from date

  • Accounting[].ValidityTo (string) – Validity to date

  • ClusterAllocationName (string) – Cluster allocation name

  • ClusterNodeTypeAggregation.AllocationType (string) – Allocation type

  • ClusterNodeTypeAggregation.Description (string) – Description

  • ClusterNodeTypeAggregation.Id (integer) – Id

  • ClusterNodeTypeAggregation.Name (string) – Name

  • ClusterNodeTypeAggregation.ValidityFrom (string) – Valid from

  • ClusterNodeTypeAggregation.ValidityTo (string) – Valid to

  • CoresPerNode (integer) – Number of cores per node

  • Description (string) – Description

  • FileTransferMethodId (integer) – File transfer id

  • Id (integer) – Id

  • MaxWalltime (integer) – Maximum of walltime

  • Name (string) – Name

  • NumberOfNodes (integer) – Number of nodes

  • Projects[].AccountingString (string) – Accounting string

  • Projects[].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Projects[].CommandTemplates[].Description (string) – Description

  • Projects[].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • Projects[].CommandTemplates[].Id (integer) – Id

  • Projects[].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • Projects[].CommandTemplates[].IsGeneric (boolean) – Is generic

  • Projects[].CommandTemplates[].Name (string) – Name

  • Projects[].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • Projects[].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • Projects[].Description (string) – Description

  • Projects[].EndDate (string) – End date

  • Projects[].Id (integer) – Id

  • Projects[].Name (string) – Name

  • Projects[].StartDate (string) – Start date

  • Projects[].UsageType (integer)

  • Projects[].UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • QualityOfService (string) – Quality of service

  • Queue (string) – Queue

PUT /heappe/Management/ClusterNodeType

Modify ClusterNodeType

Request JSON Object:

  • ClusterAllocationName (string) – Cluster allocation name

  • ClusterId (integer) – Cluster id

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • CoresPerNode (integer) – Number of cores per node

  • Description (string) – Description

  • FileTransferMethodId (integer) – File transfer method id

  • Id (integer) – Id

  • MaxWalltime (integer) – Maximum wall time

  • Name (string) – Name

  • NumberOfNodes (integer) – Number of nodes

  • QualityOfService (string) – Quality of service

  • Queue (string) – Queue

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • Accounting[].CreatedAt (string) – Created at date

  • Accounting[].Formula (string) – Formula

  • Accounting[].Id (integer) – Id

  • Accounting[].ModifiedAt (string) – Modified at date

  • Accounting[].ValidityFrom (string) – Validity from date

  • Accounting[].ValidityTo (string) – Validity to date

  • ClusterAllocationName (string) – Cluster allocation name

  • ClusterNodeTypeAggregation.AllocationType (string) – Allocation type

  • ClusterNodeTypeAggregation.Description (string) – Description

  • ClusterNodeTypeAggregation.Id (integer) – Id

  • ClusterNodeTypeAggregation.Name (string) – Name

  • ClusterNodeTypeAggregation.ValidityFrom (string) – Valid from

  • ClusterNodeTypeAggregation.ValidityTo (string) – Valid to

  • CoresPerNode (integer) – Number of cores per node

  • Description (string) – Description

  • FileTransferMethodId (integer) – File transfer id

  • Id (integer) – Id

  • MaxWalltime (integer) – Maximum of walltime

  • Name (string) – Name

  • NumberOfNodes (integer) – Number of nodes

  • Projects[].AccountingString (string) – Accounting string

  • Projects[].CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • Projects[].CommandTemplates[].Description (string) – Description

  • Projects[].CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • Projects[].CommandTemplates[].Id (integer) – Id

  • Projects[].CommandTemplates[].IsEnabled (boolean) – Is enabled

  • Projects[].CommandTemplates[].IsGeneric (boolean) – Is generic

  • Projects[].CommandTemplates[].Name (string) – Name

  • Projects[].CommandTemplates[].TemplateParameters[].Description (string) – Description

  • Projects[].CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • Projects[].Description (string) – Description

  • Projects[].EndDate (string) – End date

  • Projects[].Id (integer) – Id

  • Projects[].Name (string) – Name

  • Projects[].StartDate (string) – Start date

  • Projects[].UsageType (integer)

  • Projects[].UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • QualityOfService (string) – Quality of service

  • Queue (string) – Queue

DELETE /heappe/Management/ClusterNodeType

Remove ClusterNodeType

Request JSON Object:

  • Id (integer) – Id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/ClusterProxyConnection

Get ClusterProxyConnection by id

Query Parameters:

  • Id (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • Host (string) – Host

  • Id (integer) – Id

  • Password (string) – Password

  • Port (integer) – Port number

  • Type (integer)

  • Username (string) – Username

POST /heappe/Management/ClusterProxyConnection

Create ClusterProxyConnection

Request JSON Object:

  • Host (string) – Host

  • Password (string) – Password

  • Port (integer) – Port

  • SessionCode (string) – Session code

  • Type (integer)

  • Username (string) – User name

Status Codes:
Response JSON Object:

  • Host (string) – Host

  • Id (integer) – Id

  • Password (string) – Password

  • Port (integer) – Port number

  • Type (integer)

  • Username (string) – Username

PUT /heappe/Management/ClusterProxyConnection

Modify ClusterProxyConnection

Request JSON Object:

  • Host (string) – Host

  • Id (integer) – Id

  • Password (string) – Password

  • Port (integer) – Port

  • SessionCode (string) – Session code

  • Type (integer)

  • Username (string) – User name

Status Codes:
Response JSON Object:

  • Host (string) – Host

  • Id (integer) – Id

  • Password (string) – Password

  • Port (integer) – Port number

  • Type (integer)

  • Username (string) – Username

DELETE /heappe/Management/ClusterProxyConnection

Remove ClusterProxyConnection

Request JSON Object:

  • Id (integer) – Id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/FileTransferMethod

Get FileTransferMethod by id

Query Parameters:

  • Id (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • Id (integer) – Id

  • Port (integer) – Port

  • Protocol (integer)

  • ServerHostname (string) – Server host name

  • SharedBasepath (string) – Shared base path

POST /heappe/Management/FileTransferMethod

Create FileTransferMethod

Request JSON Object:

  • ClusterId (integer) – Cluster id

  • Port (integer) – Port

  • Protocol (integer)

  • ServerHostname (string) – Server host name

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • Id (integer) – Id

  • Port (integer) – Port

  • Protocol (integer)

  • ServerHostname (string) – Server host name

  • SharedBasepath (string) – Shared base path

PUT /heappe/Management/FileTransferMethod

Modify FileTransferMethod

Request JSON Object:

  • ClusterId (integer) – Cluster id

  • Id (integer) – Id

  • Port (integer) – Port

  • Protocol (integer)

  • ServerHostname (string) – Server hostname

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • Id (integer) – Id

  • Port (integer) – Port

  • Protocol (integer)

  • ServerHostname (string) – Server host name

  • SharedBasepath (string) – Shared base path

DELETE /heappe/Management/FileTransferMethod

Remove FileTransferMethod

Request JSON Object:

  • Id (integer) – Id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/ClusterNodeTypeAggregation

Get ClusterNodeTypeAggregation by id

Query Parameters:

  • Id (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • AllocationType (string) – Allocation type

  • Description (string) – Description

  • Id (integer) – Id

  • Name (string) – Name

  • ValidityFrom (string) – Valid from

  • ValidityTo (string) – Valid to

POST /heappe/Management/ClusterNodeTypeAggregation

Create ClusterNodeTypeAggregations

Request JSON Object:

  • AllocationType (string) – Allocation type

  • Description (string) – Description

  • Name (string) – Name

  • SessionCode (string) – Session code

  • ValidityFrom (string) – Validity from

  • ValidityTo (string) – Validity to

Status Codes:
Response JSON Object:

  • AllocationType (string) – Allocation type

  • Description (string) – Description

  • Id (integer) – Id

  • Name (string) – Name

  • ValidityFrom (string) – Valid from

  • ValidityTo (string) – Valid to

PUT /heappe/Management/ClusterNodeTypeAggregation

Modify ClusterNodeTypeAggregations

Request JSON Object:

  • AllocationType (string) – Allocation type

  • Description (string) – Description

  • Id (integer) – Id

  • Name (string) – Name

  • SessionCode (string) – Session code

  • ValidityFrom (string) – Validity from

  • ValidityTo (string) – Validity to

Status Codes:
Response JSON Object:

  • AllocationType (string) – Allocation type

  • Description (string) – Description

  • Id (integer) – Id

  • Name (string) – Name

  • ValidityFrom (string) – Valid from

  • ValidityTo (string) – Valid to

DELETE /heappe/Management/ClusterNodeTypeAggregation

Remove ClusterNodeTypeAggregation

Request JSON Object:

  • Id (integer) – Id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/ClusterNodeTypeAggregations

Get all ClusterNodeTypeAggregations

Query Parameters:

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • [].AllocationType (string) – Allocation type

  • [].Description (string) – Description

  • [].Id (integer) – Id

  • [].Name (string) – Name

  • [].ValidityFrom (string) – Valid from

  • [].ValidityTo (string) – Valid to

GET /heappe/Management/ClusterNodeTypeAggregationAccounting

Get ClusterNodeTypeAggregationAccounting by id

Query Parameters:

  • ClusterNodeTypeAggregationId (integer)

  • AccountingId (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • AccountingId (integer) – Accounting id

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

POST /heappe/Management/ClusterNodeTypeAggregationAccounting

Create ClusterNodeTypeAggregationAccounting

Request JSON Object:

  • AccountingId (integer) – Accounting id

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • AccountingId (integer) – Accounting id

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

DELETE /heappe/Management/ClusterNodeTypeAggregationAccounting

Remove ClusterNodeTypeAggregationAccounting

Request JSON Object:

  • AccountingId (integer) – Accounting id

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/Accounting

Get Accounting by id

Query Parameters:

  • Id (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • CreatedAt (string) – Created at date

  • Formula (string) – Formula

  • Id (integer) – Id

  • ModifiedAt (string) – Modified at date

  • ValidityFrom (string) – Validity from date

  • ValidityTo (string) – Validity to date

POST /heappe/Management/Accounting

Create Accounting

Request JSON Object:

  • Formula (string) – Formula

  • SessionCode (string) – Session code

  • ValidityFrom (string) – Validity from

  • ValidityTo (string) – Validity to

Status Codes:
Response JSON Object:

  • CreatedAt (string) – Created at date

  • Formula (string) – Formula

  • Id (integer) – Id

  • ModifiedAt (string) – Modified at date

  • ValidityFrom (string) – Validity from date

  • ValidityTo (string) – Validity to date

PUT /heappe/Management/Accounting

Modify Accounting

Request JSON Object:

  • Formula (string) – Formula

  • Id (integer) – Id

  • SessionCode (string) – Session code

  • ValidityFrom (string) – Validity from

  • ValidityTo (string) – Validity to

Status Codes:
Response JSON Object:

  • CreatedAt (string) – Created at date

  • Formula (string) – Formula

  • Id (integer) – Id

  • ModifiedAt (string) – Modified at date

  • ValidityFrom (string) – Validity from date

  • ValidityTo (string) – Validity to date

DELETE /heappe/Management/Accounting

Remove Accounting

Request JSON Object:

  • Id (integer) – Id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/ProjectClusterNodeTypeAggregation

Get ProjectClusterNodeTypeAggregation by id

Query Parameters:

  • ProjectId (integer)

  • ClusterNodeTypeAggregationId (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • AllocationAmount (integer) – Allocation amount

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • CreatedAt (string) – Created at date

  • ModifiedAt (string) – Modified at date

  • ProjectId (integer) – Project id

POST /heappe/Management/ProjectClusterNodeTypeAggregation

Create ProjectClusterNodeTypeAggregation

Request JSON Object:

  • AllocationAmount (integer) – Allocation amount

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • AllocationAmount (integer) – Allocation amount

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • CreatedAt (string) – Created at date

  • ModifiedAt (string) – Modified at date

  • ProjectId (integer) – Project id

PUT /heappe/Management/ProjectClusterNodeTypeAggregation

Modify ProjectClusterNodeTypeAggregation

Request JSON Object:

  • AllocationAmount (integer) – Allocation amount

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • AllocationAmount (integer) – Allocation amount

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • CreatedAt (string) – Created at date

  • ModifiedAt (string) – Modified at date

  • ProjectId (integer) – Project id

DELETE /heappe/Management/ProjectClusterNodeTypeAggregation

Remove ProjectClusterNodeTypeAggregation

Request JSON Object:

  • ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/ProjectClusterNodeTypeAggregations

Get ProjectClusterNodeTypeAggregations by ProjectId

Query Parameters:

  • ProjectId (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • [].AllocationAmount (integer) – Allocation amount

  • [].ClusterNodeTypeAggregationId (integer) – Cluster node type aggregation id

  • [].CreatedAt (string) – Created at date

  • [].ModifiedAt (string) – Modified at date

  • [].ProjectId (integer) – Project id

GET /heappe/Management/SubProjects

List SubProjects

Query Parameters:

  • ProjectId (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • [].Description (string) – Description

  • [].EndDate (string) – End date

  • [].Id (integer) – Id

  • [].Identifier (string) – Identifier

  • [].ProjectId (integer) – Project id

  • [].StartDate (string) – Start date

GET /heappe/Management/SubProject

List SubProject

Query Parameters:

  • SubProjectId (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • Description (string) – Description

  • EndDate (string) – End date

  • Id (integer) – Id

  • Identifier (string) – Identifier

  • ProjectId (integer) – Project id

  • StartDate (string) – Start date

POST /heappe/Management/SubProject

Create SubProject

Request JSON Object:

  • Description (string) – Description

  • EndDate (string) – End date

  • Identifier (string) – Identifier

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

  • StartDate (string) – Start date

Status Codes:
Response JSON Object:

  • Description (string) – Description

  • EndDate (string) – End date

  • Id (integer) – Id

  • Identifier (string) – Identifier

  • ProjectId (integer) – Project id

  • StartDate (string) – Start date

PUT /heappe/Management/SubProject

Modify SubProject

Request JSON Object:

  • Description (string) – Description

  • EndDate (string) – End date

  • Id (integer) – Id

  • Identifier (string) – Identifier

  • SessionCode (string) – Session code

  • StartDate (string) – Start date

Status Codes:
Response JSON Object:

  • Description (string) – Description

  • EndDate (string) – End date

  • Id (integer) – Id

  • Identifier (string) – Identifier

  • ProjectId (integer) – Project id

  • StartDate (string) – Start date

DELETE /heappe/Management/SubProject

Remove SubProject

Request JSON Object:

  • Id (integer) – Id

  • SessionCode (string) – Session code

Status Codes:
POST /heappe/Management/SecureShellKey

Generate SSH key

Request JSON Object:

  • Password (string)

  • ProjectId (integer)

  • SessionCode (string) – Session code

  • Username (string)

Status Codes:
Response JSON Object:

  • [].KeyType (integer)

  • [].PublicKeyOpenSSH (string) – Public key OpenSSH

  • [].PublicKeyPEM (string) – Public key PEM

  • [].Username (string) – Username

PUT /heappe/Management/SecureShellKey

Regenerate SSH key

Request JSON Object:

  • Password (string)

  • ProjectId (integer)

  • PublicKey (string)

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • KeyType (integer)

  • PublicKeyOpenSSH (string) – Public key OpenSSH

  • PublicKeyPEM (string) – Public key PEM

  • Username (string) – Username

DELETE /heappe/Management/SecureShellKey

Remove SSH key

Request JSON Object:

  • ProjectId (integer)

  • PublicKey (string)

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/SecureShellKeys

Get SSH keys for project

Query Parameters:

  • ProjectId (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • [].KeyType (integer)

  • [].PublicKeyOpenSSH (string) – Public key OpenSSH

  • [].PublicKeyPEM (string) – Public key PEM

  • [].Username (string) – Username

POST /heappe/Management/GenerateSecureShellKey

Generate SSH key

Request JSON Object:

  • Credentials[].Password (string) – Password

  • Credentials[].Username (string) – User name

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • [].KeyType (integer)

  • [].PublicKeyOpenSSH (string) – Public key OpenSSH

  • [].PublicKeyPEM (string) – Public key PEM

  • [].Username (string) – Username

PUT /heappe/Management/RegenerateSecureShellKey

Regenerate SSH key

Request JSON Object:

  • Password (string) – Password

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

  • Username (string) – User name

Status Codes:
Response JSON Object:

  • KeyType (integer)

  • PublicKeyOpenSSH (string) – Public key OpenSSH

  • PublicKeyPEM (string) – Public key PEM

  • Username (string) – Username

DELETE /heappe/Management/RemoveSecureShellKey

Remove SSH key

Request JSON Object:

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

  • Username (string) – User name

Status Codes:
POST /heappe/Management/InitializeClusterScriptDirectory

Initialize cluster script directory for SSH HPC Account

Request JSON Object:

  • ClusterProjectRootDirectory (string) – Cluster project root directory

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • [].ClusterName (string) – Cluster name

  • [].IsClusterInitialized (boolean) – Is cluster initialized

POST /heappe/Management/TestClusterAccessForAccount

Test cluster access for robot account

Request JSON Object:

  • ProjectId (integer)

  • PublicKey (string)

  • SessionCode (string) – Session code

Status Codes:
GET /heappe/Management/TestClusterAccessForAccount

Test cluster access for robot account

Query Parameters:

  • Username (string)

  • ProjectId (integer)

  • SessionCode (string)

Status Codes:
POST /heappe/Management/ComputeAccounting

Compute accounting - calculate accounting via accounting formulas

Request JSON Object:

  • EndTime (string) – End time

  • ProjectId (integer) – Project id

  • SessionCode (string) – Session code

  • StartTime (string) – Start time

Status Codes:
POST /heappe/Management/AccountingState
Query Parameters:

  • ProjectId (integer)

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • ComputingEndDate (string) – Comuputing end date

  • ComputingStartDate (string) – Comuputing start date

  • LastUpdatedAt (string) – Last updated at

  • ProjectId (integer) – Project id

  • State (integer)

  • TriggeredAt (string) – Triggered at

POST /heappe/UserAndLimitationManagement/AuthenticateLexisToken

Provide user authentication via OpenId token.

Request JSON Object:

  • Credentials.OpenIdAccessToken (string) – OpenId access token (required)

  • Credentials.Username (string) – User name

Status Codes:
POST /heappe/UserAndLimitationManagement/AuthenticateUserOpenId

Provide user authentication via OpenId token.

Request JSON Object:

  • Credentials.OpenIdAccessToken (string) – OpenId access token (required)

  • Credentials.Username (string) – User name

Status Codes:
POST /heappe/UserAndLimitationManagement/AuthenticateUserOpenStack

Provide user authentication to OpenStack.

Request JSON Object:

  • Credentials.OpenIdAccessToken (string) – OpenId access token (required)

  • Credentials.Username (string) – User name

  • ProjectId (integer) – Project id

Status Codes:
Response JSON Object:

  • ApplicationCredentialsId (string) – Application credentials id

  • ApplicationCredentialsSecret (string) – Application credentials secret

POST /heappe/UserAndLimitationManagement/AuthenticateUserPassword

Provide user authentication

Request JSON Object:

  • Credentials.Password (string) – Password

  • Credentials.Username (string) – User name

Status Codes:
POST /heappe/UserAndLimitationManagement/AuthenticateUserDigitalSignature

Provide user authentication

Request JSON Object:

  • Credentials.DigitalSignature[] (integer)

  • Credentials.Noise (string) – Noise

  • Credentials.Username (string) – User name

Status Codes:
GET /heappe/UserAndLimitationManagement/CurrentUsageAndLimitationsForCurrentUser

Get current resource usage

Query Parameters:

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • [].AccountingString (string) – Accounting string

  • [].Description (string) – Description

  • [].EndDate (string) – End date

  • [].Id (integer) – Id

  • [].Name (string) – Name

  • [].NodeTypes[].CoresPerNode (integer) – Number of cores per node

  • [].NodeTypes[].Description (string) – Description

  • [].NodeTypes[].FileTransferMethodId (integer) – File transfer method id

  • [].NodeTypes[].Id (integer) – Id

  • [].NodeTypes[].MaxWalltime (integer) – Maximum walltime

  • [].NodeTypes[].Name (string) – Name

  • [].NodeTypes[].NodeUsedCoresAndLimitation.CoresUsed (integer) – Number of cores used

  • [].NodeTypes[].NumberOfNodes (integer) – Number of nodes

  • [].StartDate (string) – Start date

GET /heappe/UserAndLimitationManagement/ProjectsForCurrentUser

Get projects for current user

Query Parameters:

  • SessionCode (string)

Status Codes:
Response JSON Object:

  • [].Project.AccountingString (string) – Accounting string

  • [].Project.CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • [].Project.CommandTemplates[].Description (string) – Description

  • [].Project.CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • [].Project.CommandTemplates[].Id (integer) – Id

  • [].Project.CommandTemplates[].IsEnabled (boolean) – Is enabled

  • [].Project.CommandTemplates[].IsGeneric (boolean) – Is generic

  • [].Project.CommandTemplates[].Name (string) – Name

  • [].Project.CommandTemplates[].TemplateParameters[].Description (string) – Description

  • [].Project.CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • [].Project.Description (string) – Description

  • [].Project.EndDate (string) – End date

  • [].Project.Id (integer) – Id

  • [].Project.Name (string) – Name

  • [].Project.StartDate (string) – Start date

  • [].Project.UsageType (integer)

  • [].Project.UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • [].Role.Description (string) – Description (required)

  • [].Role.Name (string) – Name (required)

GET /heappe/UserAndLimitationManagement/CurrentUserInfo

Get current user info

Query Parameters:

  • SessionCode (string) – Session code

Status Codes:
Response JSON Object:

  • AdaptorUserGroups[].Description (string) – Description

  • AdaptorUserGroups[].Id (integer) – Id

  • AdaptorUserGroups[].Name (string) – Name

  • AdaptorUserGroups[].Project.AccountingString (string) – Accounting string

  • AdaptorUserGroups[].Project.CommandTemplates[].CreatedFromGenericTemplateId (integer) – Created from generic template id

  • AdaptorUserGroups[].Project.CommandTemplates[].Description (string) – Description

  • AdaptorUserGroups[].Project.CommandTemplates[].ExtendedAllocationCommand (string) – Extended allocation command

  • AdaptorUserGroups[].Project.CommandTemplates[].Id (integer) – Id

  • AdaptorUserGroups[].Project.CommandTemplates[].IsEnabled (boolean) – Is enabled

  • AdaptorUserGroups[].Project.CommandTemplates[].IsGeneric (boolean) – Is generic

  • AdaptorUserGroups[].Project.CommandTemplates[].Name (string) – Name

  • AdaptorUserGroups[].Project.CommandTemplates[].TemplateParameters[].Description (string) – Description

  • AdaptorUserGroups[].Project.CommandTemplates[].TemplateParameters[].Identifier (string) – Identifier

  • AdaptorUserGroups[].Project.Description (string) – Description

  • AdaptorUserGroups[].Project.EndDate (string) – End date

  • AdaptorUserGroups[].Project.Id (integer) – Id

  • AdaptorUserGroups[].Project.Name (string) – Name

  • AdaptorUserGroups[].Project.StartDate (string) – Start date

  • AdaptorUserGroups[].Project.UsageType (integer)

  • AdaptorUserGroups[].Project.UseAccountingStringForScheduler (boolean) – Use accounting string for scheduler

  • AdaptorUserGroups[].Roles[] (string)

  • Email (string) – Email

  • Id (integer) – Id

  • PublicKey (string) – Public key

  • UserType (integer)

  • Username (string) – Username