Review Expiration Behavior

Configure what happens when reviews expire.

This setting is configurable on the Access Reviews > Settings page. Enable Reject incomplete rows to reject and sign off on undecided rows when a review expires.

This API allows you to change the behavior when a review expires (which can be enabled in Review Auto-Complete Settings). Depending on the behavior, incomplete rows can be auto-rejected when the review deadline passes.

Review expiration behavior can be configured globally, or for all reviews for a single Review Configuration, specified by workflow_id in the request.

Request Structure

The request body must include a setting object with the following structure:

{
  "workflow_id": "string",
  "setting": {
    "behavior": 0,
    "note_to_add": "string"
  }
}

Parameters

Where:

• workflow_id (string, optional): Specific review configuration ID. If omitted, applies globally to all reviews.

• setting.behavior (integer): The expiration behavior mode:

  • 0 = DO_NOTHING: No action is made on incomplete rows (default)

  • 1 = AUTO_REJECT_INCOMPLETE_RESULTS: Reject and sign-off any results that are incomplete when the review expires

• setting.note_to_add (string, optional): Note to be added when auto-rejecting incomplete results

Example

Example request:

{
  "workflow_id": "string",
  "setting": {
    "behavior": 1,
    "note_to_add": "Rejected incomplete result due to review expiration."
  }
}

Get Review Expiration Behavior

Get Review Expiration Settings

get

Authorizations

Query parameters

workflow_idstringOptionalExample: <string>

Header parameters

AcceptstringOptionalExample: application/json

Responses

200

OK

application/json

Responseobject

get

HTTPcURLJavaScriptPython

GET /api/private/workflows/access/global_settings/review_expiration_behavior HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "value": "AUTO_REJECT_INCOMPLETE_RESULTS",
  "setting": {
    "behavior": 0,
    "note_to_add": "Rejected incomplete result due to review expiration."
  }
}

Set Review Expiration Behavior

Set Review Expiration Settings

put

Authorizations

Header parameters

Content-TypestringOptionalExample: application/json

AcceptstringOptionalExample: application/json

Body

workflow_idstringOptional

Optional workflow ID for configuration-specific settings

Responses

200

OK

application/json

Responseobject

put

HTTPcURLJavaScriptPython

PUT /api/private/workflows/access/global_settings/review_expiration_behavior HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "workflow_id": "string",
  "setting": {
    "behavior": 1,
    "note_to_add": "Rejected incomplete result due to review expiration."
  }
}

200

OK

{
  "value": "AUTO_REJECT_INCOMPLETE_RESULTS",
  "setting": {
    "behavior": 1,
    "note_to_add": "Rejected incomplete result due to review expiration."
  }
}