Skip to main content
POST
Create verification-test overlay

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

confirm
boolean
default:false

Set confirm=true when op=remove suppresses a resolved test ref.

Body

application/json
scope
enum<string>
required

Overlay scope: tenant, project, or artifact.

Available options:
tenant,
project,
artifact
subject_type
enum<string>
required

Artifact family this overlay affects.

Available options:
html,
document,
deck,
workbook
op
enum<string>
required

Add a custom definition, or remove a test ref from the resolved set.

Available options:
add,
remove
scope_id
string | null

Project or artifact id. Omit for tenant scope, which derives the authenticated organization.

Minimum string length: 1
custom_test_id
string | null

Custom definition id. Required only for op=add.

Minimum string length: 1
target_ref
string | null

Resolved test ref to suppress. Required only for op=remove.

Required string length: 1 - 255

Response

Successful Response

data
VerificationTestAttachment · object
required