Skip to main content
API · Dataset Pairs GET /api/v1/dataset-pairs/{datasetPairUuid}/validation-capabilities/{functionCode}/fields Requires the GV.APIReader application role, or a higher role (Owner > Contributor > Reader). Operation ID · list_dataset_pair_validation_compatible_fields

Request example

Authentication and access

  • Required role: GV.APIReader
  • Data classification: metadata
  • Side effects: none
Use an authentication scheme declared below. Ordinary workloads use application tokens; signed-in users use delegated tokens and Organization membership. Activation and invitation acceptance require a person, and execution callbacks require their registered identity.
  • Microsoft Entra delegated user token
  • Microsoft Entra application token

Parameters

datasetPairUuid

path Required Opaque Dataset Pair UUID. string (uuid) Opaque Dataset Pair UUID.

functionCode

path Required Exact, case-sensitive public validation function code. Schema ValidationFunctionCode string Exact, case-sensitive public validation function code.
  • Allowed values: "COUNT_ROWS","COUNT","COUNT_DISTINCT","MIN","MAX","AVG","SUM","VALUE","OUTER_VALUE","SET_A_IN_B","SET_B_IN_A","SET_A_EQUALS_B"

limit

query integer
  • Default: 50
minimum: 1 · maximum: 100

cursor

query string | null Any of Option 1: string string maximum length: 2048 Option 2: null null

sourceField

query Exact source field path used to bound compatible target discovery. string | null Exact source field path used to bound compatible target discovery. Any of Option 1: string string minimum length: 1 · maximum length: 1024 Option 2: null null

sourceCollectionPath

query Exact source collection path; omit for a root field. string | null Exact source collection path; omit for a root field. Any of Option 1: string string minimum length: 1 · maximum length: 1024 Option 2: null null

Responses

This guide summarizes response status codes and headers. Retrieve the deployed, authenticated OpenAPI document for the exact response body schemas and examples. The API also provides an authenticated Swagger UI; opening it in a browser does not automatically attach a bearer token. Error responses use application/problem+json. The response’s stable code and type map to the error-code reference.

200

Successful Response

401

A valid Microsoft Entra bearer token is required.

403

The authenticated principal does not have the required role.

404

The resource does not exist in this tenant.

422

The request is syntactically valid but semantically invalid.

429

The bounded application request rate was exceeded.

Headers

  • Retry-After: Seconds to wait before retrying. integerminimum: 1

503

A required dependency is temporarily unavailable.

Headers

  • Retry-After: Seconds to wait before retrying. integerminimum: 1