Job Monitoring

HEAppE Middleware provides endpoint for the Submitted Jobs Monitoring. The endpoint is available at /heappe/JobManagement/CurrentInfoForJob and it requires the following parameters:

HEAppE Current Info for Job Parameters
Field	Type	Description	Example Values
SubmittedJobInfoId	integer	The job identifier returned by the `/heappe/JobManagement/SubmitJob` endpoint.	1
SessionCode	string	The session code returned by the `Authentication` endpoint.

Example Request

curl -X 'GET' \
 'http://localhost:5000/heappe/JobManagement/CurrentInfoForJob?sessionCode=123e4567-e89b-12d3-a456-426614174000&submittedJobInfoId=1' \
 -H 'accept: application/json'

Job State Mapping

Actual Job State is returned as an integer value. The following table shows the mapping between the integer value and the actual state.

HEAppE Job/Task State Mapping
Integer Value	State
1	`Configuring`
2	`Submitted`
4	`Queued`
8	`Running`
16	`Finished`
32	`Failed`
64	`Canceled`
128	`WaitingForServiceAccount`
256	`Deleted`

Example Response

{
  "Id": 0,
  "Name": "string",
  "State": 1,
  "CreationTime": "2024-06-21T06:13:00.598Z",
  "SubmitTime": "2024-06-21T06:13:00.598Z",
  "StartTime": "2024-06-21T06:13:00.598Z",
  "EndTime": "2024-06-21T06:13:00.598Z",
  "TotalAllocatedTime": 0,
  "Tasks": [
    {
      "Id": 0,
      "Name": "string",
      "State": 1,
      "Priority": 0,
      "AllocatedTime": 0,
      "AllocatedCoreIds": [
        "string"
      ],
      "StartTime": "2024-06-21T06:13:00.598Z",
      "EndTime": "2024-06-21T06:13:00.598Z",
      "NodeType": {
        "Id": 0,
        "Name": "string",
        "Description": "string",
        "Project": {
          "Id": 0,
          "Name": "string",
          "Description": "string",
          "AccountingString": "string",
          "CommandTemplate": {
            "Id": 0,
            "Name": "string",
            "Description": "string",
            "ExtendedAllocationCommand": "string",
            "IsGeneric": true,
            "TemplateParameters": [
              {
                "Identifier": "string",
                "Description": "string"
              }
            ]
          }
        }
      },
      "ErrorMessage": "string",
      "CpuHyperThreading": true
    }
  ]
}