FLECS
HomeMarketplaceRessourcesGet started
Engineering
Engineering
  • API Docs
    • FLECS Console API
      • Welcome!
      • Quick Start
      • API Reference
        • Authentication
        • Users
        • Products
        • Device
        • Apps
    • FLECS Core API
      • API Reference
        • System
        • Device
        • Console
        • Instances
        • Apps
        • Jobs
  • App Publishing Guide
    • 💡Overview
    • 🪛How to create a FLECS app
    • 🚀How to release a FLECS app
    • 🧳App Publishing Packages
    • 📶Network
  • FLECS Core
    • Install FLECS Core Using Docker
  • White Labeling
    • Integrate views
    • On-premise hosting of apps
Powered by GitBook
On this page

Was this helpful?

  1. API Docs
  2. FLECS Core API
  3. API Reference

Jobs

PreviousAppsNextOverview

Last updated 3 months ago

Was this helpful?

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

get
Responses
200
Success
application/json
get
GET /v2/jobs HTTP/1.1
Host: localhost
Accept: */*
200

Success

[
  {
    "id": 1,
    "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

get
Path parameters
job_idintegerRequired

job_id to query

Responses
200
Success
application/json
404
Not found
get
GET /v2/jobs/{job_id} HTTP/1.1
Host: localhost
Accept: */*
{
  "id": 1,
  "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

delete
Path parameters
job_idintegerRequired

job_id to query

Responses
200
Success
400
Job not finished
text/plain
404
Not found
delete
DELETE /v2/jobs/{job_id} HTTP/1.1
Host: localhost
Accept: */*

No content

  • GETRetrieve a list of all pending/queued/running/failed/cancelled jobs
  • GETRetrieve information for specific job_id
  • DELETECancel job or remove failed/successful/cancelled job from journal