AFaffinda
Validation Results

Batch create validation results

Changed on

Batch create validation results.

post/v3/validation_results/batch_create

Request

Request body

annotationsinteger[] required

List of annotation ids that were validated

passedboolean nullable

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

ruleSlugstring required

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

messagestring required

Message explaining why the validation failed

documentstring required

Unique identifier for the document

Example request

[
  {
    "annotations": [
      1,
      2,
      3
    ],
    "passed": true,
    "ruleSlug": "supplier-name-is-alphanumeric",
    "message": "Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*"
  }
]

Response

Successfully created validation results.

idinteger required

Validation Result's ID

annotationsinteger[] required

List of annotation ids that were validated

passedboolean nullable required

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

ruleSlugstring required

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

messagestring required

Message explaining why the validation failed

documentstring required

Unique identifier for the document

Example response

[
  {
    "id": 1,
    "annotations": [
      1,
      2,
      3
    ],
    "passed": true,
    "ruleSlug": "supplier-name-is-alphanumeric",
    "message": "Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*"
  }
]

Changes