Get a broker connection's instrument universe status

GET

/admin/broker-connections/{code}/universe

curl --request GET \
  --url http://localhost:3001/admin/broker-connections/string/universe \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:3001/admin/broker-connections/string/universe"

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/broker-connections/string/universe";

    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

code

required

string

Broker connection code

Responses

200

application/json

object

count

required

Instruments currently mapped to this connection’s broker.

integer format: int64

last_job

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

reason

Why the state is partial or failed: “interrupted”, “10 skipped: …”, or the load’s error.

string

nullable

state

required

Where a broker connection’s instrument universe stands.

string

Allowed values: not_loaded loading loaded partial failed

Example

{
  "last_job": {
    "status": "queued"
  },
  "state": "not_loaded"
}

404

Not found