minimusdocs
Help center

Background tasks

Get a background task

GET/jobs/{kind}/{id}/

read Read: looks, changes nothing. Scopes

Its state, progress, details and what you may do to it now.

Path parameters

  • idstringrequired

    The task's id.

  • kindstringrequired

    The kind of task, as in its kind.

    One of: "backup" "bulk_delete" "bulk_edit" "editor" "import" "ingest" "panel_import" "provider_import" "series_import" "watch_scan"

Response

200 OK

  • idstringrequired
  • kindstringrequired
    • import - Playlist import
    • bulk_delete - Mass delete
    • bulk_edit - Mass edit
    • ingest - VOD ingest
    • series_import - TV show import
    • provider_import - Film and show import
    • watch_scan - Watch folder scan
    • backup - Backup
    • panel_import - Move from another panel
    • editor - Playlist editor

    One of: "import" "bulk_delete" "bulk_edit" "ingest" "series_import" "provider_import" "watch_scan" "backup" "panel_import" "editor"

  • kind_labelstringrequired
  • titlestringrequired
  • subtitlestringrequired
  • statestringrequired

    Where the task is, in the same words for every kind.

    • queued - Queued
    • running - Running
    • waiting - Waiting for you
    • stalled - Stalled
    • completed - Completed
    • failed - Failed
    • cancelled - Cancelled
  • state_labelstringrequired
  • statusstringrequired

    The task's own status, in its kind's words.

  • status_labelstringrequired
  • progressobjectrequired
    • doneintegerrequiredcan be null
    • totalintegerrequiredcan be null
    • percentintegerrequiredcan be null
    • phasestringrequired
  • messagestringrequired
  • detailsobject[]required
    • labelstringrequired
    • valueanyrequired
  • errorsobject[]required

    What went wrong for single items, when the kind records it.

  • linkobjectrequiredcan be null
    • pathstringrequired

      The dashboard page that shows this task.

    • queryobjectrequired
    • labelstringrequired
  • actionsstring[]required

    What the signed-in account may do to it now.

    One of: "cancel" "resume" "retry" "undo"

  • created_by_usernamestringrequiredcan be null
  • created_atstring (date-time)required
  • started_atstring (date-time)requiredcan be null
  • finished_atstring (date-time)requiredcan be null
  • updated_atstring (date-time)required

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 404 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means