PATCH
/
api
/
end_user_files
/
{heron_id}
/
parsed_result
curl --request PATCH \
  --url https://app.herondata.io/api/end_user_files/{heron_id}/parsed_result \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "parsed_result": {}
}'
{
  "attribute_values": [
    {}
  ],
  "created": "2023-11-07T05:31:56Z",
  "field_validations": [
    {
      "failure_reason": "<string>",
      "field_name": "<string>",
      "result": "pass",
      "validation_type": "<string>"
    }
  ],
  "heron_id": "<string>",
  "id": 123,
  "parser_id": "<string>",
  "parsing_status": "succeeded",
  "result": {}
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
heron_id
string
required

The file's heron_id

Query Parameters

​
parser_id
string
required

The ID of the parser to update results for

Body

application/json
​
parsed_result
object

Response

200 - application/json
OK
​
created
string
required
​
heron_id
string
required

Unique identifier of the end user file

​
parser_id
string
required
​
parsing_status
enum<string>
required
Available options:
succeeded,
failed,
processing
​
attribute_values
object[]
​
field_validations
object[]
​
id
integer

[DEPRECATED] Unique identifier for the parsed file

​
result
object | null

Was this page helpful?

Trigger async parsing of an end user fileGet parsed results from uploaded files