ValidateJson

Description:

Validates the contents of FlowFiles against a configurable JSON Schema. See json-schema.org for specification standards.

Tags:

JSON, schema, validation

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
JSON SchemaJSON SchemaThe content of a JSON Schema

This property requires exactly one resource to be provided. That resource may be any of the following types: file, text, URL.
Schema VersionSchema VersionDraft 2020-12
  • Draft 4 Draft Version 4
  • Draft 6 Draft Version 6
  • Draft 7 Draft Version 7
  • Draft 2019-09 Draft Version 2019-09
  • Draft 2020-12 Draft Version 2020-12
The JSON schema specification

Relationships:

NameDescription
validFlowFiles that are successfully validated against the schema are routed to this relationship
invalidFlowFiles that are not valid according to the specified schema are routed to this relationship
failureFlowFiles that cannot be read as JSON are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
json.validation.errorsIf the flow file is routed to the invalid relationship , this attribute will contain the error message resulting from the validation failure.

State management:

This component does not store state.

Restricted:

Required PermissionExplanation
reference remote resourcesSchema configuration can reference resources over HTTP

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

ResourceDescription
MEMORYValidating JSON requires reading FlowFile content into memory