approvalPolicy

Evaluate the active approval policies against a quote version

Reports which approval policies finalizing this quote version would breach, why, and who would have to approve. Creates and changes nothing. Requires QUOTE.VIEW as well as APPROVAL_POLICY.VIEW, because the answer reports the quote version's own values. Requires the APPROVAL_POLICY.VIEW permission.

post/v{version}/approval-policies/evaluate

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/approval-policies/evaluate
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

quote_version_idstring required

The ID of the quote version to evaluate the active approval policies against.

Response

OK

object_typestring nullable
status'NO_APPROVAL_REQUIRED' | 'APPROVAL_REQUIRED' | 'CANNOT_BE_DETERMINED'

What finalizing this quote version would do about approval.

triggered_approval_policy_idsstring[] nullable

The IDs of the approval policies that would be breached.

approval_strategy'ALL_LEVELS_MUST_APPROVE' | 'HIGHER_LEVEL_CAN_OVERRIDE' | 'ANYONE_CAN_DECIDE'

The approval strategy that would be applied to the approval request, the most restrictive of the triggered policies.

Changes

No recorded changes to this operation across all 1 revision of this API.