Approve / Reject Policy Control Execution

PUT /policies/policy-control-executions/{policyControlExecutionId}

Update the status of a policy control execution to approve or reject. Like a multi-sig wallet, if multiple approvers are required based on numApprovals in the corresponding PolicyControl, the execution status will not update until all required approvals are received.

Required Permissions

NameConditions

PolicyControlExecutions:Update

Always Required

Request body

Request body fieldsRequired/OptionalDescriptionType

name

Required

A name for the rule

String

status

Required

"Passed" OR "Failed"

Enumerated Type (String)

Request Example

{
     "status": "Passed"
}

Response

Response example

If successful, the response contains a status indicating whether the policy control execution has Passed, Failed, or is still Awaiting approval. documentedActivity contains an escaped JSON object of the transaction data which initiated the policy execution.

{
    "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": "Passed"
}

Last updated