GET
/
v3
/
validation_results
Get list of all validation results
curl --request GET \
  --url https://{region}.affinda.com/v3/validation_results \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "annotations": [
      1,
      2,
      3
    ],
    "passed": true,
    "ruleSlug": "supplier-name-is-alphanumeric",
    "message": "Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*",
    "document": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Query Parameters

​
offset
integer

The number of documents to skip before starting to collect the result set.

Required range: x >= 0
Example:

0

​
limit
integer

The numbers of results to return.

Required range: 1 <= x <= 100
Example:

20

​
document
string
required

Filter by document.

Response

All matching workspace memberships.

​
id
integer
required

Validation Result's ID

Required range: x >= 1
Example:

1

​
annotations
integer[]
required

List of annotation ids that were validated

Example:
[1, 2, 3]
​
passed
boolean | null
required

Whether the validation passed or not, null if the validation was not applicable

Example:

true

​
ruleSlug
string
required

The kebab-case slug of the validation rule that was applied

Example:

"supplier-name-is-alphanumeric"

​
message
string
required

Message explaining why the validation failed

Example:

"Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*"

​
document
string
required

Unique identifier for the document