Saltar al contenido principal
PATCH
/
v1
/
rules
/
{rule_id}
Actualizar una Regla
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": "Nombre de regla actualizado",
  "description": "Descripcion actualizada"
}
'
{
  "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"
}

Encabezados

​
Content-Type
string
requerido

El tipo de medio del recurso. Debe ser application/json.

​
X-API-Key
string
requerido

La clave API para autenticacion. Este encabezado es requerido para todos los endpoints excepto verificaciones de salud.

​
X-Request-Id
string<uuid>

Un identificador unico usado para rastrear y seguir cada solicitud.

Parámetros de ruta

​
rule_id
string<uuid>
requerido

El identificador unico de la regla que desea recuperar, actualizar o eliminar.

Cuerpo

application/json

Entrada para actualizar una regla. Al menos un campo debe ser proporcionado.

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

Expresion CEL (solo modificable para reglas DRAFT).

Required string length: 1 - 5000
​
action
enum<string>
Opciones disponibles:
ALLOW,
DENY,
REVIEW
​
scopes
object[]
Maximum array length: 100

Respuesta

Indica que la regla fue actualizada exitosamente.

Regla de validacion.

​
ruleId
string<uuid>

Identificador unico de la regla.

​
name
string

Nombre de regla legible para humanos (globalmente unico).

Maximum string length: 255
​
description
string

Proposito y explicacion de la logica de la regla.

Maximum string length: 1000
​
expression
string

Expresion CEL que debe evaluar a booleano.

Maximum string length: 5000
​
action
enum<string>

Accion tomada cuando la expresion de la regla evalua a verdadero.

Opciones disponibles:
ALLOW,
DENY,
REVIEW
​
scopes
object[]

Alcances que determinan a que transacciones aplica esta regla.

​
status
enum<string>

Estado del ciclo de vida de la regla.

Opciones disponibles:
DRAFT,
ACTIVE,
INACTIVE,
DELETED
​
createdAt
string<date-time>

Cuando se creo la regla.

​
updatedAt
string<date-time>

Cuando se modifico la regla por ultima vez.

​
activatedAt
string<date-time> | null

Cuando la regla fue activada por ultima vez (null si nunca fue activada).

​
deactivatedAt
string<date-time> | null

Cuando la regla fue desactivada por ultima vez (null si nunca fue desactivada).

​
deletedAt
string<date-time> | null

Cuando la regla fue eliminada (null si no fue eliminada).