Parâmetros de invocação de API PaCE

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 1 min. de leitura

    • Essa tabela descreve as propriedades que podem ser configuradas quando a API PaCE é invocada. Essas propriedades podem ser definidas sempre que a API é invocada ou quando você testa uma política no Playground de teste.

    Nome da propriedade Obrigatório Valor padrão Descrição
    serviço sim O serviço de chamada que está invocando a API.
    categoria não O tipo de categoria.
    tipo não padrão Pode ser padrão ou teste.
    documentIds sim (matriz de tabela, sysID) O documentIds é uma matriz da tabela e do sysID (do implantável).
    Nota:
    As propriedades mostradas na tabela anterior não podem ser configuradas no Playground de teste. Elas só podem ser usadas quando a API PaCE é invocada.
    dados sim Os dados específicos da política que incluem todas as entradas possíveis do solicitante.
    executionTag não Pode ser usado para marcar um ou mais registros de execuções de política resultantes dessa invocação. Pode ser usado para recuperar detalhes de execução da política com base no executionTag.
    verboseResponse não falso O valor padrão é falso. Se definido como verdadeiro, as informações de depuração adicionais (nesse caso, os IDs das políticas mapeadas) serão retornadas.
    Um exemplo de resposta de invocação com options.verboseResponse:true é mostrado aqui:
    // Sample execution response
{
  "rootExecutionId": "50202b3ec37b101017e06c576e40dd81",
  "mappedPolicies": [
    {
      "policyId": "3d1de0a8c363101017e06c576e40dde4",
      "policyName": "Production Database Policy",
      "shortDescription": "Policy to check database passwords",
      "versonId": "4ed08520c3a3101017e06c576e40ddcb",
      "versonTyep": "4f2cb75473331010ce6c39282bf6a753",
      "versionState": "published",
      "versionApproval": "approved"
    },
    {
      "policyId": "addd2ca8c363101017e06c576e40dd12",
      "policyName": "API Policy",
      "shortDescription": "Policy to check API policies",
      "versonId": "a6418920c3a3101017e06c576e40dd57",
      "versonTyep": "4f2cb75473331010ce6c39282bf6a753",
      "versionState": "published",
      "versionApproval": "approved"
    }
  ],
  "logs": []
}
    Se options.verboseResponse:false, as políticas mapeadas não serão incluídas na resposta.
    failFast não falso O valor padrão é falso. Se essa propriedade for definida como verdadeiro, a primeira política com falha interromperá a execução de todas as políticas mapeadas.
    logLevel não informações Esse parâmetro pode ser usado para especificar como as mensagens de log devem ser exibidas.
    • informações
    • depurar
    • aviso
    • Erro
    tempo limite não 3600 O período de tempo limite em segundos. O valor padrão é 3600.
    waitForResult não 3600 O período waitForResult em segundos.
    Nota:
    Esse parâmetro está disponível somente no Playground de teste.