HEherondata
EndUserFiles

Get parsed results from uploaded files

get/api/end_user_files/{heron_id}/parsed_results

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/end_user_files/{heron_id}/parsed_results
  • Auth
    API key in header x-api-key

Path parameters

heron_idstring required

The file's heron_id - beginning with 'euf_'

Query parameters

parser_idstring nullable
version_numberinteger nullable

Response

OK

attribute_valuesobject[]
createdstring date-time required
heron_idstring required

Unique identifier of the end user file

idinteger

[DEPRECATED] Unique identifier for the parsed file

parser_display_namestring
parser_idstring required
parsing_status'succeeded' | 'failed' | 'processing' required
resultobject nullable

Final output result after applying patches

result_schemaobject

The output JSON schema the results conform to

validation_summarystring

Summary of validation results

Example response

[
  {
    "field_validations": [
      {
        "result": "pass"
      }
    ]
  }
]

Changes

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