Skip to main content
GET
Get

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow. Request an access token from the token endpoint and send it as Authorization: Bearer <token>.

Path Parameters

id
string<uuid>
required

Id of the job, as returned by the write that created it.

Response

The action job.

One submitted change and the outcome of applying it.

id
string<uuid>
required

Id of this job.

Example:

"9f2b1c7e-5a84-4d6b-9c31-0e7f8a2d4b16"

startedAt
string<date-time>
required

When the job was accepted.

status
enum<string>
required

Where the job has got to. Queued and Running are not terminal; every other value is.

Available options:
Queued,
Running,
Completed,
PartiallyCompleted,
Failed,
Cancelled,
Reverted,
PartiallyReverted
targets
object
required

How many targets the change was applied to, and how they turned out. Targets still in flight are the remainder. Some changes expand server-side into the records that actually have to be altered, so these counts are not final while the status is Queued. A total of zero there means the target set is still being resolved, not that there is nothing to do.

type
enum<string>
required

Whether this job applied a change or undid one. A revert cannot itself be reverted, so this is what tells a caller which jobs are candidates.

Available options:
Change,
Revert
completedAt
string<date-time> | null

When the job reached a terminal status; null while it is still running.

dataSync
object

Whether Oleria's own data reflects this change yet. A job can be complete, with the change applied in the application, while reads here still return the previous value.

operation
string

The operation that started this job, named as it appears in this API (for example DisableAccount). Absent for changes made through the Oleria application rather than through this API, which have no operation to name.

Example:

"DisableAccount"

revert
object

Whether this job's change can still be undone.

revertedBy
string<uuid> | null

The revert job that undid this one. Null until this job has been reverted, which makes the pair navigable from either end.

reverts
string<uuid> | null

The job this one undoes. Set when type is Revert, null otherwise.