Get a background job and its log

GET

/admin/jobs/{id}

curl --request GET \
  --url http://localhost:3001/admin/jobs/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:3001/admin/jobs/00000000-0000-0000-0000-000000000000"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "http://localhost:3001/admin/jobs/00000000-0000-0000-0000-000000000000";

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .headers(headers)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

Authorizations

bearer_token

Parameters

Path Parameters

required

string format: uuid

Job id

Responses

200

application/json

object

job

required

object

created_at

required

string format: date-time

error

string

nullable

finished_at

string format: date-time

nullable

required

string format: uuid

kind

required

universe_load, enrichment, symbology_backfill or expiry_sweep.

string

params

required

progress_done

integer format: int64

nullable

progress_total

integer format: int64

nullable

result

nullable

started_at

string format: date-time

nullable

started_by

required

system for work the OMS started itself, else the admin action.

string

status

required

string

Allowed values: queued running succeeded failed interrupted

subject

What the job is about, e.g. a broker connection code.

string

nullable

log

required

The job’s own log, oldest line first (the newest 500 are kept).

Array<object>

object

required

string format: date-time

level

required

string

message

required

string

Example

{
  "job": {
    "status": "queued"
  }
}

404

Not found