Data Staging API Reference Guide

This document describes the Internal Data Staging API of the HEAppE Middleware.

This API is accessible only within the server where the Data Staging service (and HEAppE Middleware) is running. This interface provides SSH key for the user to use for File Transfer when the HPC Center doesn’t allow to propagate public key to .ssh/authorized_keys file (if it is possible, please use the FileTransfer API).

POST /api/DataStaging/GetFileTransferMethod

Obtain data transfer information for job.

Obtain credentials and information for ensuring job data transfer.

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 413 Request Entity Too Large – Payload Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /api/DataStaging/DownloadPartsOfJobFilesFromCluster

Get specific part of FileType content.

Get specific part of FileType content.<br>FileType: LogFile - 0, ProgressFile - 1, StandardErrorFile - 2, StandardOutputFile - 3.

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 413 Request Entity Too Large – Payload Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

GET /api/DataStaging/ListChangedFilesForJob

Get all changed files during job execution.

Get all changed files during job execution with modification timestamp.

Query Parameters:

• SessionCode (string) – SessionCode (Required)

• SubmittedJobInfoId (integer) – SubmittedJobInfoId (Required)

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 413 Request Entity Too Large – Payload Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error

POST /api/DataStaging/DownloadFileFromCluster

Get content of file

Get content of the specific file on HPC infrastructure. Content is encoded in BASE64 format.

Status Codes:

• 200 OK – OK

• 400 Bad Request – Bad Request

• 401 Unauthorized – Unauthorized

• 413 Request Entity Too Large – Payload Too Large

• 429 Too Many Requests – Too Many Requests

• 500 Internal Server Error – Internal Server Error