PaCE API invocation parameters

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read

    • This table describes the properties that can be configured when the PaCE API is invoked. These properties can be set whenever the API is invoked or when you test a policy in the Test Playground.

    Property name Required Default value Description
    service yes The calling service that is invoking the API.
    category no The category type.
    type no standard Can be standard or test.
    documentIds yes (array of table, sysID) The documentIds is an array of the table and sysID (of the deployable).
    Note:
    The properties shown in the preceding table cannot be configured in the Test Playground. They can only be used when the PaCE API is invoked.
    data yes The policy-specific data that includes all possible caller inputs.
    executionTag no Can be used to tag one or more policy executions records resulting from this invocation. It can be used to retrieve execution details of the policy based on the executionTag.
    verboseResponse no false Default value is false. If set to true, additional debug information (in this case the ids of the mapped policies) is returned.
    A sample invocation response with options.verboseResponse:true is shown here:
    // 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": []
}
    If options.verboseResponse:false, the mapped policies are not included in the response.
    failFast no false The default value is false. If this property is set to true, the first failed policy stops the execution of all the mapped policies.
    logLevel no info This parameter can be used to specify how the log messages should be displayed.
    • info
    • debug
    • warn
    • error
    timeout no 3600 The timeout period in seconds. The default value is 3600.
    waitForResult no 3600 The waitForResult period in seconds.
    Note:
    This parameter is available only in the Test Playground.