| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ValidateJson</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ValidateJson</h1><h2>Description: </h2><p>Validates the contents of FlowFiles against a configurable JSON Schema. See json-schema.org for specification standards.</p><h3>Tags: </h3><p>JSON, schema, validation</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>JSON Schema</strong></td><td>JSON Schema</td><td></td><td id="allowable-values"></td><td id="description">The content of a JSON Schema<br/><br/><strong>This property requires exactly one resource to be provided. That resource may be any of the following types: text, file, URL.</strong><br/></td></tr><tr><td id="name"><strong>Schema Version</strong></td><td>Schema Version</td><td id="default-value">Draft 2020-12</td><td id="allowable-values"><ul><li>Draft 4 <img src="../../../../../html/images/iconInfo.png" alt="Draft Version 4" title="Draft Version 4"></img></li><li>Draft 6 <img src="../../../../../html/images/iconInfo.png" alt="Draft Version 6" title="Draft Version 6"></img></li><li>Draft 7 <img src="../../../../../html/images/iconInfo.png" alt="Draft Version 7" title="Draft Version 7"></img></li><li>Draft 2019-09 <img src="../../../../../html/images/iconInfo.png" alt="Draft Version 2019-09" title="Draft Version 2019-09"></img></li><li>Draft 2020-12 <img src="../../../../../html/images/iconInfo.png" alt="Draft Version 2020-12" title="Draft Version 2020-12"></img></li></ul></td><td id="description">The JSON schema specification</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>valid</td><td>FlowFiles that are successfully validated against the schema are routed to this relationship</td></tr><tr><td>invalid</td><td>FlowFiles that are not valid according to the specified schema are routed to this relationship</td></tr><tr><td>failure</td><td>FlowFiles that cannot be read as JSON are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>json.validation.errors</td><td>If the flow file is routed to the invalid relationship , this attribute will contain the error message resulting from the validation failure.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>Validating JSON requires reading FlowFile content into memory</td></tr></table></body></html> |