Pular para o conteúdo principal

Configuração da Organização

Configurações globais da Decision Platform para a organização.

Endpoints

MétodoEndpointDescriçãoPermissão
GET/api/v1/decision-platform/org-configObter configuraçãoDECISIONS_READ
PUT/api/v1/decision-platform/org-configAtualizar configuraçãoDECISIONS_MANAGE
PATCH/api/v1/decision-platform/org-configAtualização parcialDECISIONS_MANAGE
DELETE/api/v1/decision-platform/org-configResetar para padrãoDECISIONS_MANAGE

Atributos

CampoTipoDescriçãoPadrão
maxConcurrentExecutionsnumberMáximo de execuções simultâneas100
maxRetriesnumberMáximo de retentativas em falhas3
retryBackoffMsnumberTempo base de backoff (ms)1000
retryBackoffMultipliernumberMultiplicador de backoff2
executionRetentionDaysnumberDias de retenção de execuções30
currentExecutionCountnumberExecuções ativas (somente leitura)-
isDefaultbooleanSe está usando configuração padrão-

Obter Configuração

GET /api/v1/decision-platform/org-config

Retorna a configuração atual da organização. Se não houver configuração customizada, retorna os valores padrão.

curl 'https://decision-platform.stg.catalisa.app/api/v1/decision-platform/org-config' \
-H 'Authorization: Bearer SEU_TOKEN'

Response (200 OK)

{
"data": {
"type": "organization-platform-config",
"id": "550e8400-e29b-41d4-a716-446655440200",
"attributes": {
"organizationId": "550e8400-e29b-41d4-a716-446655440000",
"maxConcurrentExecutions": 100,
"maxRetries": 3,
"retryBackoffMs": 1000,
"retryBackoffMultiplier": 2,
"executionRetentionDays": 30,
"currentExecutionCount": 5,
"isDefault": false,
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-15T10:00:00Z"
}
},
"links": {
"self": "/api/v1/org-config"
}
}

Atualizar Configuração

PUT /api/v1/decision-platform/org-config

Atualiza a configuração da organização (substitui todos os campos).

Atributos

CampoTipoRangeDescrição
maxConcurrentExecutionsnumber1-10000Limite de execuções simultâneas
maxRetriesnumber0-10Tentativas em caso de falha
retryBackoffMsnumber100-60000Tempo base de espera entre retries
retryBackoffMultipliernumber1-5Multiplicador exponencial
executionRetentionDaysnumber1-365Dias para manter histórico
curl -X PUT 'https://decision-platform.stg.catalisa.app/api/v1/decision-platform/org-config' \
-H 'Authorization: Bearer SEU_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"type": "organization-platform-config",
"attributes": {
"maxConcurrentExecutions": 200,
"maxRetries": 5,
"retryBackoffMs": 2000,
"retryBackoffMultiplier": 2.5,
"executionRetentionDays": 90
}
}
}'

Atualização Parcial

PATCH /api/v1/decision-platform/org-config

Atualiza apenas os campos especificados.

curl -X PATCH 'https://decision-platform.stg.catalisa.app/api/v1/decision-platform/org-config' \
-H 'Authorization: Bearer SEU_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"type": "organization-platform-config",
"attributes": {
"maxConcurrentExecutions": 500
}
}
}'

Resetar para Padrão

DELETE /api/v1/decision-platform/org-config

Remove a configuração customizada e volta aos valores padrão.

curl -X DELETE 'https://decision-platform.stg.catalisa.app/api/v1/decision-platform/org-config' \
-H 'Authorization: Bearer SEU_TOKEN'

Response (204 No Content)

Sem corpo de resposta.


Estratégia de Retry

Quando uma execução falha (por erro de data source ou outro problema recuperável), a plataforma pode tentar novamente automaticamente:

  1. Primeira tentativa - Imediata
  2. Segunda tentativa - Após retryBackoffMs (ex: 1000ms)
  3. Terceira tentativa - Após retryBackoffMs * retryBackoffMultiplier (ex: 2000ms)
  4. N-ésima tentativa - Após retryBackoffMs * retryBackoffMultiplier^(n-1)

O máximo de tentativas é controlado por maxRetries.


Controle de Concorrência

O maxConcurrentExecutions limita quantas execuções podem rodar simultaneamente na organização:

  • Execuções que excedem o limite recebem erro 429 Rate Limit
  • O campo currentExecutionCount mostra o uso atual
  • Use para proteger recursos e garantir SLA

Retenção de Dados

O executionRetentionDays controla por quanto tempo as execuções são mantidas:

  • Após o período, execuções são automaticamente removidas
  • Importante para compliance e controle de armazenamento
  • Mínimo: 1 dia, Máximo: 365 dias

Erros Comuns

CódigoErroDescrição
400VALIDATIONValor fora do range permitido
403FORBIDDENSem permissão para gerenciar configuração