ROrossum
Annotation Content

Validate annotation content

Validate the content of an annotation. At first, the content is sent to the validate hook of connected extension. Then some standard validations (data type, constraints are checked) are carried out in Rossum. Additionally, if the annotation's respective queue has enabled delete recommendation conditions, they are evaluated as well.

By default, messages for hidden datapoints are omitted. The behavior could be changed using the messages_for_hidden_datapoints=true query parameter.

post/api/v1/annotations/{annotationID}/content/validate

Request

Query parameters

messages_for_hidden_datapointsboolean

Include messages for hidden datapoints

Request body

actionsstring[]

Validation actions. Possible values: ["user_update"], ["user_update", "updated"] or ["user_update", "started"]

updated_datapoint_idsinteger[]

List of IDs of datapoints that were changed since last call of this endpoint.

Response

Validation results

updated_datapointsobject[]

The subtrees of datapoints updated from an extension

suggested_operationsobject[]

Datapoint operations suggested as a result of validation

matched_trigger_rulesobject[]

Delete Recommendation rules that matched

Changes

No recorded changes to this operation across all 14 revisions of this API.