Jobs

Retrieve a list of all pending/queued/running/failed/cancelled jobs

GEThttp://localhost/v2/jobs

Response

200

Success

Body

application/json

id*job_id (integer (int32))

status*job_status (enum)

pendingqueuedrunningcancelledsuccessfulfailedunknown

description*string

Example: "Installation of FLECS App 1 (1.2.3.4-f1)"

numSteps*integer

Example: 5

currentStep*job_step (object)

result*job_result (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/jobs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 0,
    "status": "pending",
    "description": "Installation of FLECS App 1 (1.2.3.4-f1)",
    "numSteps": 5,
    "currentStep": {
      "description": "Downloading...",
      "num": 3,
      "unit": "B",
      "unitsTotal": 10485761,
      "unitsDone": 5120000,
      "rate": 2048
    },
    "result": {
      "code": -1,
      "message": "Explanation what went wrong"
    }
  }
]

Retrieve information for specific job_id

GEThttp://localhost/v2/jobs/{job_id}

Path parameters

job_id*integer

job_id to query

Response

200404

Success

Body

application/json

id*job_id (integer (int32))

status*job_status (enum)

pendingqueuedrunningcancelledsuccessfulfailedunknown

description*string

Example: "Installation of FLECS App 1 (1.2.3.4-f1)"

numSteps*integer

Example: 5

currentStep*job_step (object)

result*job_result (object)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/jobs/{job_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 0,
  "status": "pending",
  "description": "Installation of FLECS App 1 (1.2.3.4-f1)",
  "numSteps": 5,
  "currentStep": {
    "description": "Downloading...",
    "num": 3,
    "unit": "B",
    "unitsTotal": 10485761,
    "unitsDone": 5120000,
    "rate": 2048
  },
  "result": {
    "code": -1,
    "message": "Explanation what went wrong"
  }
}

Cancel job or remove failed/successful/cancelled job from journal

DELETEhttp://localhost/v2/jobs/{job_id}

Path parameters

job_id*integer

job_id to query

Response

200400404

Success

Request

JavaScriptCurlPython

const response = await fetch('http://localhost/v2/jobs/{job_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400

text