Pular para o conteúdo principal
PATCH
/
v1
/
rules
/
{rule_id}
Atualizar uma Regra
curl --request PATCH \
  --url https://tracer.lerian.io/v1/rules/{rule_id} \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "name": "Updated rule name",
  "description": "Updated description"
}
'
{
  "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "expression": "<string>",
  "action": "ALLOW",
  "scopes": [
    {
      "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionType": "CARD",
      "subType": "<string>"
    }
  ],
  "status": "DRAFT",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "activatedAt": "2023-11-07T05:31:56Z",
  "deactivatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Cabeçalhos

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

​
X-API-Key
string
obrigatório

A chave de API para autenticação. Este header é obrigatório para todos os endpoints, exceto verificações de integridade.

​
X-Request-Id
string<uuid>

Um identificador único usado para rastrear cada requisição.

Parâmetros de caminho

​
rule_id
string<uuid>
obrigatório

O identificador único da regra que você deseja recuperar, atualizar ou excluir.

Corpo

application/json

Entrada para atualizar uma regra. Pelo menos um campo deve ser fornecido.

​
name
string
Required string length: 1 - 255
​
description
string
Maximum string length: 1000
​
expression
string

Expressão CEL (modificável apenas para regras com status DRAFT).

Required string length: 1 - 5000
​
action
enum<string>
Opções disponíveis:
ALLOW,
DENY,
REVIEW
​
scopes
object[]
Maximum array length: 100

Resposta

Indica que a regra foi atualizada com sucesso.

Regra de validação.

​
ruleId
string<uuid>

Identificador único da regra.

​
name
string

Nome legível da regra (globalmente único).

Maximum string length: 255
​
description
string

Propósito e explicação da lógica da regra.

Maximum string length: 1000
​
expression
string

Expressão CEL que deve avaliar para booleano.

Maximum string length: 5000
​
action
enum<string>

Ação tomada quando a expressão da regra avalia como verdadeira.

Opções disponíveis:
ALLOW,
DENY,
REVIEW
​
scopes
object[]

Escopos que determinam a quais transações esta regra se aplica.

​
status
enum<string>

Status do ciclo de vida da regra.

Opções disponíveis:
DRAFT,
ACTIVE,
INACTIVE,
DELETED
​
createdAt
string<date-time>

Quando a regra foi criada.

​
updatedAt
string<date-time>

Quando a regra foi modificada pela última vez.

​
activatedAt
string<date-time> | null

Quando a regra foi ativada pela última vez (nulo se nunca ativada).

​
deactivatedAt
string<date-time> | null

Quando a regra foi desativada pela última vez (nulo se nunca desativada).

​
deletedAt
string<date-time> | null

Quando a regra foi excluída (nulo se não excluída).