Pular para o conteúdo principal
POST
Despachar exceção para sistema externo

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Chave de idempotência opcional para novas tentativas seguras. Também aceita Idempotency-Key como nome alternativo do cabeçalho. Se a mesma chave for enviada novamente e a requisição original já tiver sido processada, a resposta em cache é retornada com X-Idempotency-Replayed: true.

Consulte Novas tentativas e idempotência para mais detalhes.

Parâmetros de caminho

exceptionId
string
obrigatório

Exception ID

Corpo

application/json

Payload de despacho

Payload da requisição de despacho

targetSystem
enum<string>
obrigatório

Sistema de destino para o despacho

Opções disponíveis:
JIRA,
SERVICENOW,
WEBHOOK,
MANUAL
Maximum string length: 255
Exemplo:

"JIRA"

queue
string

Atribuição opcional de fila ou equipe

Maximum string length: 255
Exemplo:

"RECON-TEAM"

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a requisição acabou de ser processada. Se o valor for true, a resposta é uma repetição de uma requisição processada anteriormente.

Consulte Retries and idempotency para mais detalhes.

Resultado do despacho

acknowledged
boolean

Indica se o despacho foi confirmado

Exemplo:

true

dispatchedAt
string

Quando o despacho ocorreu no formato RFC3339

Exemplo:

"2025-01-15T10:30:00.000Z"

exceptionId
string

ID da exceção que foi despachada

Exemplo:

"019c96a0-10d2-7134-ba5f-664142ee7052"

externalReference
string

ID de referência externo do sistema de destino

Exemplo:

"RECON-1234"

target
string

Sistema de destino para o qual foi despachado

Exemplo:

"JIRA"