Rearm a parked executor result

curl --request POST \
  --url https://api.example.com/v1/admin/executor/orders/{orderId}/revisions/{revision}/results/{executionVersion}/rearm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Mensageria outage fixed; re-sending the parked result."
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/admin/executor/orders/{orderId}/revisions/{revision}/results/{executionVersion}/rearm"

	payload := strings.NewReader("{\n  \"reason\": \"Mensageria outage fixed; re-sending the parked result.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Mensageria outage fixed; re-sending the parked result.'})
};

fetch('https://api.example.com/v1/admin/executor/orders/{orderId}/revisions/{revision}/results/{executionVersion}/rearm', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/admin/executor/orders/{orderId}/revisions/{revision}/results/{executionVersion}/rearm"

payload = { "reason": "Mensageria outage fixed; re-sending the parked result." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "attemptsBefore": 123,
  "executionVersion": 123,
  "orderId": "<string>",
  "outcome": "REARMED",
  "rearmedAt": "2023-11-07T05:31:56Z",
  "rearmedBy": "<string>",
  "revision": 123
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Rearm a parked executor result

Gives a result outbox row parked at the drainer’s attempt cap (EXECUTOR_RESULT_MAX_ATTEMPTS) its way out: attempts go back to 0 and the drainer retries it at once, so later versions of the same order held behind it can follow. A human platform-administrator action (executor_result:rearm, never held by M2M): an application token (SBJ-0044) or a tenant-carrying token (SBJ-0045) is refused with 403. The reset, its journal row and its audit row commit in one transaction. Every attempt with a known result, accepted or refused, is recorded append-only in the audit trail with the reason. 200 outcome NOOP: the result is pending but not parked (nothing changed). 409 SBJ-0048: the result is terminal. 422 SBJ-0049: reason missing, blank, longer than 200 characters or containing personal data. 422 SBJ-0050: multi-tenant deployment (the rearm is single-tenant only). 404: unknown result.

POST

admin

executor

orders

{orderId}

revisions

{revision}

results

{executionVersion}

rearm

Rearm a parked executor result

curl --request POST \
  --url https://api.example.com/v1/admin/executor/orders/{orderId}/revisions/{revision}/results/{executionVersion}/rearm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Mensageria outage fixed; re-sending the parked result."
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/admin/executor/orders/{orderId}/revisions/{revision}/results/{executionVersion}/rearm"

	payload := strings.NewReader("{\n  \"reason\": \"Mensageria outage fixed; re-sending the parked result.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Mensageria outage fixed; re-sending the parked result.'})
};

fetch('https://api.example.com/v1/admin/executor/orders/{orderId}/revisions/{revision}/results/{executionVersion}/rearm', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/admin/executor/orders/{orderId}/revisions/{revision}/results/{executionVersion}/rearm"

payload = { "reason": "Mensageria outage fixed; re-sending the parked result." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "attemptsBefore": 123,
  "executionVersion": 123,
  "orderId": "<string>",
  "outcome": "REARMED",
  "rearmedAt": "2023-11-07T05:31:56Z",
  "rearmedBy": "<string>",
  "revision": 123
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "details": {}
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

orderId

string

obrigatório

The executor order's identifier (UUID).

Exemplo:

"0b9b7c2e-4f8a-4d3e-9a51-7c2d1e0f3a44"

revision

integer<int64>

obrigatório

The order revision (>= 1).

Intervalo obrigatório: x >= 1

Exemplo:

1

executionVersion

integer<int64>

obrigatório

The result's execution version (>= 1).

Intervalo obrigatório: x >= 1

Exemplo:

1

Corpo

application/json

reason

string

Required. Short justification (at most 200 characters, no personal data: CPF, CNPJ, judicial process numbers). Stored sealed in the audit trail; never echoed.

Exemplo:

"Mensageria outage fixed; re-sending the parked result."

Resposta

attemptsBefore

integer<int64>

obrigatório

The row's attempts when the request read it.

executionVersion

integer<int64>

obrigatório

The result's execution version.

orderId

string

obrigatório

The executor order's identifier.

outcome

enum<string>

obrigatório

REARMED: attempts reset to 0, the drainer retries it now. NOOP: the result was pending but not parked; nothing changed.

Opções disponíveis:

REARMED,

NOOP

rearmedAt

string<date-time>

obrigatório

Instant of the request (UTC).

rearmedBy

string

obrigatório

Subject of the platform administrator who made the request.

revision

integer<int64>

obrigatório

The order revision.

SISBAJUD Mensageria · Instituições

SISBAJUD Mensageria · Ordens e arquivos

SISBAJUD Mensageria · Monitoramento

SISBAJUD Mensageria · Arquivos de retorno

SISBAJUD Mensageria · Solicitações LGPD

SISBAJUD Mensageria · Segurança

SISBAJUD Mensageria · Conformidade

SISBAJUD Mensageria · Dead letter do Lerian STA

SISBAJUD executor · Instituições e conector Midaz

SISBAJUD executor · Canal direto

SISBAJUD executor · Ordens que precisam de atenção

SISBAJUD executor · Roteamento de ledger

SISBAJUD executor · Segurança

SISBAJUD executor · Auditoria

Tratamento de erros

Rearm a parked executor result

Autorizações

Parâmetros de caminho

Corpo

Resposta