Pular para o conteúdo principal
POST
Criar um agendamento

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

contextId
string
obrigatório

The unique identifier of the reconciliation context.

Corpo

application/json

Detalhes do agendamento

Payload para criação de uma agenda de conciliação

cronExpression
string
obrigatório

Expressão cron que define a frequência da agenda

Required string length: 1 - 100
Exemplo:

"0 0 * * *"

enabled
boolean

Indica se a agenda deve ser ativada imediatamente

Exemplo:

true

Resposta

Agendamento criado.

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.

Agenda de conciliação baseada em cron

id
string<uuid>

Identificador único da agenda

Exemplo:

"019c96a0-2b20-7123-9a1b-2c3d4e5f6a7b"

contextId
string<uuid>

Contexto ao qual esta agenda pertence

Exemplo:

"019c96a0-2a10-7dfe-b5c1-8a1b2c3d4e5f"

cronExpression
string

Expressão cron que define a agenda

Maximum string length: 100
Exemplo:

"0 0 * * *"

enabled
boolean

Indica se a agenda está ativa

Exemplo:

true

lastRunAt
string<date-time>

Horário da última execução bem-sucedida no formato RFC 3339

Exemplo:

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

nextRunAt
string<date-time>

Horário da próxima execução agendada no formato RFC 3339

Exemplo:

"2025-01-16T00:00:00Z"

createdAt
string<date-time>

Timestamp de criação no formato RFC 3339

Exemplo:

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

updatedAt
string<date-time>

Timestamp da última atualização no formato RFC 3339

Exemplo:

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