List Policy Control Executions

GET /policies/policy-control-executions/

Lists all PolicyControlExecutions belonging to an Org. Can be filtered by the query string parameters listed below.

Required Permissions

NameConditions

PolicyControlExecutions:Read

Always Required

Parameters

Query parameters

Query string parameterRequired/OptionalDescription

onlyMyPendingApprovals=true

Optional

Returns only those policy control executions awaiting approval by the user sending the API request.

onlyInitiatedByMe=true

Optional

Returns only those policy control executions initiated by a transaction sent by the user sending the API request.

activityId=pa-oven-arn-4k08

Optional

Returns policy control executions triggered by the specified activityId.

Response

Response example

If successful, the response contains a list of policy control executions:

{
   "items": [
    {
      "policyExecutionId": "pole-maryland-uranus-5aabe7932c",
      "author": "ce-early-violet-703a68145bca",
      "versionedId": "pce-oven-arizona-40f0948dc9@f1d694k08",
      "controlId": "pc-ack-king-84df80db48",
      "documentedActivity": "{\"receiver\":{\"kind\":\"BlockchainWalletAddress\",\"address\":\"5GZVcXPsJhJtJyQf3qVLw4kYi9KUV2SjNQS6PhyhjgV7\"},\"assetSymbol\":\"SOL\",\"amount\":\"0.1\",\"note\":\"TEST-amount-3-1658251350817\",\"assetAccountId\":\"aa-muppet-crazy-b2fa6ab7a8\",\"initiator\":{\"kind\":\"Employee\",\"orgId\":\"cu-purple-pip-1b417b958500\",\"employeeId\":\"ce-early-violet-703a68145bca\"},\"status\":\"Initiated\",\"dateCreated\":\"2022-07-19T17:22:30.962Z\",\"orgId\":\"cu-purple-pip-1b417b958500\",\"receiverAddress\":\"5GZVcXPsJhJtJyQf3qVLw4kYi9KUV2SjNQS6PhyhjgV7\",\"id\":\"pa-black-island-56a129c84f\"}",
      "version": "f1d694k08",
      "dateExecuted": "2022-07-19T17:22:31.304Z",
      "controlKind": "RequestApproval",
      "orgId": "cu-purple-pip-1b417b958500",
      "approverUsernames": ["bob@example.com"],
      "dateFullfiled": null,
      "id": "pce-oven-arizona-40f0948dc9",
      "status": "Awaiting"
    }
, 
...
   ]
}

Last updated