Force Update Result

Update a single result with escalated privileges

ForceUpdateAwfResults allows administrators to modify results more than normally allowed, such as changing sign-off status, or changing a row's decision after a certification expires.

Method
syntax

POST

/api/preview/awf/certifications/{certification_id}/results:force_update

The API token used for this request must be created for a user with the admin role.

A forced update request:

  • Can undo sign-off of a row.

  • On an expired or completed certification, during the grace period, rows can be modified as normal (Assuming they're no longer signed off).

    • The grace period for changes is 7 days after certification completion or expiration

A standard update request:

  • Can't undo sign-off of a row.

  • On an expired certification, during the grace period, a rejected row can be marked as fixed by admin/operator.

Parameters

Field
In
Value

certification_id

path

ID of the certification containing the result to alter

value

body

Contains a single certification result and keys to update

result_id

body

Numeric result id to update (min 0)

decision

body

Result decision(NONE, REJECTED, ACCEPTED, FIXED)

notes

body

string of most recent row notes

reviewers

body

signed_off_state

body

Sign-off status (NOT_SIGNED_OFF, SIGNED_OFF)

notification_status

body

Integration status (UNKNOWN, PENDING, SUCCEED, FAILED)

Sample Request

curl '{{VEZA_URL}}/api/preview/awf/certifications/f9123002-978f-f203bc9885ed/results:force_update' \
  -H 'authorization: Bearer '$token \
  -D '{"value": {"result_id": 0,"signed_off_state":"NOT_SIGNED_OFF"}}'

Sample Response

A successful response will be empty:

{}

Last updated