Skip to main content
PUT
Update a Test

Authorizations

Authorization
string
header
required

Microsoft Entra application token issued by the caller's Organization tenant for this multitenant API. Request the .default scope and assign the application the required GV.APIReader, GV.APIContributor, or GV.APIOwner role.

Path Parameters

resource_id
string<uuid>
required

The Test's ID.

Body

application/json
function
enum<string>
required

The validation function. GET /api/v1/fabric/catalog lists them.

Available options:
COUNT_ROWS,
COUNT,
COUNT_DISTINCT,
MIN,
MAX,
AVG,
SUM,
VALUE,
OUTER_VALUE,
SET_A_IN_B,
SET_B_IN_A,
SET_A_EQUALS_B
evidence_limit
integer
default:100

How many mismatched rows a row or set Test saves to your Results Lakehouse. 0 saves none; it never changes the verdict.

Required range: 0 <= x <= 10000
max_bad_records
integer
default:0

How many mismatches a row or set Test can have and still pass. Aggregate Tests accept only 0.

Required range: 0 <= x <= 9007199254740991
source_column
string | null

The source column. Omit for COUNT_ROWS.

Required string length: 1 - 255
Pattern: ^[^\x00-\x1f\x7f]+$
target_column
string | null

The target column. Omit for COUNT_ROWS.

Required string length: 1 - 255
Pattern: ^[^\x00-\x1f\x7f]+$
tolerance
number
default:0

The largest absolute difference that still passes, for aggregate and row Tests. 0 requires exact equality; set Tests accept only 0.

Required range: 0 <= x <= 1000000000000000

Response

Successful Response

function
enum<string>
required

The validation function. GET /api/v1/fabric/catalog lists them.

Available options:
COUNT_ROWS,
COUNT,
COUNT_DISTINCT,
MIN,
MAX,
AVG,
SUM,
VALUE,
OUTER_VALUE,
SET_A_IN_B,
SET_B_IN_A,
SET_A_EQUALS_B
id
string<uuid>
required
pair_id
string<uuid>
required

The Table Pair the Test belongs to.

evidence_limit
integer
default:100

How many mismatched rows a row or set Test saves to your Results Lakehouse. 0 saves none; it never changes the verdict.

Required range: 0 <= x <= 10000
max_bad_records
integer
default:0

How many mismatches a row or set Test can have and still pass. Aggregate Tests accept only 0.

Required range: 0 <= x <= 9007199254740991
source_column
string | null

The source column. Omit for COUNT_ROWS.

Required string length: 1 - 255
Pattern: ^[^\x00-\x1f\x7f]+$
target_column
string | null

The target column. Omit for COUNT_ROWS.

Required string length: 1 - 255
Pattern: ^[^\x00-\x1f\x7f]+$
tolerance
number
default:0

The largest absolute difference that still passes, for aggregate and row Tests. 0 requires exact equality; set Tests accept only 0.

Required range: 0 <= x <= 1000000000000000