List stuck operations (operator dashboard)

curl --request GET \
  --url https://spb.sandbox.lerian.net/v1/str/stuck-operations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spb.sandbox.lerian.net/v1/str/stuck-operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://spb.sandbox.lerian.net/v1/str/stuck-operations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://spb.sandbox.lerian.net/v1/str/stuck-operations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://spb.sandbox.lerian.net/v1/str/stuck-operations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "capabilities": {
    "hasBudgetReArm": true,
    "hasCrashWindowRecovery": true,
    "hasDeadlineExpiry": true,
    "hasDeadlineSweep": true,
    "hasDlqReplay": true,
    "hasInboundStuckDetection": true,
    "rail": "<string>",
    "replayNowWired": true,
    "supportedVerbs": [
      "<string>"
    ]
  },
  "correlationId": "<string>",
  "items": [
    {
      "affordances": [
        {
          "requirement": "<string>",
          "verb": "<string>",
          "reasonCode": "<string>",
          "semanticsNote": "<string>"
        }
      ],
      "correlation": {
        "operationRef": "<string>",
        "messageType": "<string>",
        "protocolRef": "<string>"
      },
      "disposition": "<string>",
      "rail": "<string>",
      "reason": "<string>",
      "state": "<string>",
      "age": "<string>",
      "detail": {}
    }
  ],
  "limit": 123,
  "nextCursor": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

List stuck operations (operator dashboard)

Returns the cross-rail operator dashboard page of operations needing attention, conformed to the shared recovery vocabulary. Each row carries only the verbs SPB can actually perform on it (a verb SPB cannot perform is absent) and the disposition (‘what happens if I do nothing’). Reconciliation cases are shown with their affordances; pre-case stuck-outbound rows the dispatch sweep is retrying are shown informationally with no affordances. No monetary or position fields are returned.

GET

str

stuck-operations

curl --request GET \
  --url https://spb.sandbox.lerian.net/v1/str/stuck-operations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spb.sandbox.lerian.net/v1/str/stuck-operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://spb.sandbox.lerian.net/v1/str/stuck-operations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://spb.sandbox.lerian.net/v1/str/stuck-operations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://spb.sandbox.lerian.net/v1/str/stuck-operations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "capabilities": {
    "hasBudgetReArm": true,
    "hasCrashWindowRecovery": true,
    "hasDeadlineExpiry": true,
    "hasDeadlineSweep": true,
    "hasDlqReplay": true,
    "hasInboundStuckDetection": true,
    "rail": "<string>",
    "replayNowWired": true,
    "supportedVerbs": [
      "<string>"
    ]
  },
  "correlationId": "<string>",
  "items": [
    {
      "affordances": [
        {
          "requirement": "<string>",
          "verb": "<string>",
          "reasonCode": "<string>",
          "semanticsNote": "<string>"
        }
      ],
      "correlation": {
        "operationRef": "<string>",
        "messageType": "<string>",
        "protocolRef": "<string>"
      },
      "disposition": "<string>",
      "rail": "<string>",
      "reason": "<string>",
      "state": "<string>",
      "age": "<string>",
      "detail": {}
    }
  ],
  "limit": 123,
  "nextCursor": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Query Parameters

reason

string

Attention reason filter (e.g. STUCK_OUTBOUND, AWAITING_RAIL_RESPONSE, RETRY_FAILED, REQUIRES_OPERATOR_ACTION)

age

string

Age bucket filter (OVER_5_MIN, OVER_15_MIN, OVER_1_HOUR, OVER_1_DAY)

state

string

Canonical operation state filter (e.g. AWAITING_RESPONSE, REQUIRES_OPERATOR_ACTION, RECOVERY_IN_PROGRESS)

limit

integer<int64>

default:50

Page size (default 50, max 100)

Required range: 1 <= x <= 100

cursor

string

Opaque pagination cursor

Response

capabilities

object

required

Rail-level honest capability manifest (returned inline to save a round trip).

Show child attributes

correlationId

string

required

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

items

object[] | null

required

Stuck-operation rows needing operator attention.

Show child attributes

limit

integer<int64>

required

Page size applied to this response (max items returned).

nextCursor

string

Opaque cursor for the next page; absent when exhausted. Presence signals more results, absence signals end-of-list.

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

List stuck operations (operator dashboard)

Authorizations

Query Parameters

Response