Lexicon Garden

at.happyproto.admin.listJobs

Background jobs across every user, newest first. Staff only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityadmin.happyproto.at
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

jobType

string

Only jobs of this type.

limit

integer
  • minimum: 1
  • maximum: 200
  • default: 50

status

string

Comma-separated statuses to include. Defaults to pending,running,pausing,cancelling.

Output

application/json

jobs

requiredarray
itemsref
Reference

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not HappyProto staff.

InvalidRequest

status names an unknown status, or limit is not a whole number from 1 to 200.

Upstream

The jobs could not be read.

#adminJob

object

A background job as staff see it. Never carries its input or session fields.

Properties

completedAt

string · datetime

createdAt

requiredstring · datetime

createdBy

requiredstring · did

Who started it.

error

string

Why the job failed, as the job reported it.

id

requiredstring

A UUID.

jobType

requiredstring

progress

unknown

The job's last progress report.

result

unknown

What the job returned, once completed.

startedAt

string · datetime

status

requiredstring
  • knownValues: pending | running | paused | pausing | cancelling | completed | failed | cancelled

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • at.happyproto.server.getJob

    query

    One of the caller's own background jobs, such as the one a change to an instance started. Customers only.