The WorkflowRun object

The WorkflowRun object is the core object of the WorkflowRun API. It represents a single run of a workflow and contains all the information about the run, including the output data, the workflow that was run, and the status of the run.

properties

object

string

The type of the object, in this case it will always be “workflow_run”.

string

An ID corresponding to a specific File x Workflow combination representing the specific WorkflowRun for a File.

name

string

The name of the WorkflowRun. Autogenerated by Extend using fileName if not provided at creation time.

batchId

string

The batch ID of the WorkflowRun. If that WorkflowRun was created from a batch of files, all runs in that batch will have the same batch ID.

status

string

The status of a WorkflowRun. The options are “PENDING” (if the WorkflowRun is waiting to start execution), “PROCESSING” (if the WorkflowRun is currently running), “FAILED” (if the WorkflowRun failed), “NEEDS_REVIEW” (if the WorkflowRun needs to be reviewed manually in the UI), “REVIEWED” (if the WorkflowRun has been manually reviewed and corrected), “PROCESSED” (if the WorkflowRun is fully processed.)

url

string

Unique URL that can be used to route to the WorkflowRun review experience in Extend.

metadata

any

The metadata that was passed in when running the Workflow.

initialRunAt

string

The time (in UTC) at which the workflow was initially run.

failureMessage

string

An optional field that will only be present if applicable. This will be the error message if the WorkflowRun failed.

reviewedBy

string

An optional field that will only be present if applicable. This will be the user ID of the person who reviewed the WorkflowRun.

reviewedAt

string

An optional field that will only be present if applicable. The time (in UTC) at which the WorkflowRun review step was completed.

startTime

string

The start time (in UTC) of the WorkflowRun.

endTime

string

An optional field that will only be present if applicable. The end time (in UTC) of the WorkflowRun.

files

File[]

The files that were processed in this WorkflowRun.

See the File object for more details.

outputs

DocumentProcessorRun[]

An array of DocumentProcessorRun objects corresponding to Extraction, Classification, and Instruct QA steps. This will contain the initial output, reviewed output, and final output of the DocumentProcessorRun.

properties

object

string

Type of the object, always ‘document_processor_run’.

string

The unique identifier for the document processor run.

edited

boolean

Whether the document processor run has been edited.

edits

object

A hash of the edits (original + edited values + operator notes, if any) made to the document processor run. Values conform to the value types of the fields.

type

string

The type of the document processor run. Either EXTRACT, CLASSIFY, or SPLITTER.

config

object

The config of the document processor run. The shape of output depends on the document processor type. Details for each can be found in the Output and Config types page.

initialOutput

object

The initial raw output from the document processor. This is always set. The shape of output depends on the document processor type. Details for each can be found in the Output and Config types page.

reviewedOutput

object

An optional field that shows the output after review, if applicable. The shape of output depends on the document processor type. Details for each can be found in the Output and Config types page.

output

object

The final output, either reviewed or initial. You can rely on this to be always set as the final output (initial or post review when reviewed). The shape of output depends on the document processor type. Details for each can be found in the Output and Config types page.

workflow

Workflow

The details about the Workflow that was used in this WorkflowRun.

properties

object

string

The type of response, in this case it will always be “workflow”.

string

The unique identifier of the Workflow.

name

string

The name of the Workflow.

version

string

The version of the Workflow.

stepRuns

WorkflowStepRun[]

An array of WorkflowStepRun objects. Each WorkflowStepRun represents a single run of a WorkflowStep and contains details about the step and the run’s output.

Note: This field currently supports External Data Validation and Rule Validation step types. Document processor run outputs are included in the outputs field.

properties

object

string

The type of response, in this case it will always be “workflow_step_run”.

string

The unique identifier of the WorkflowStepRun.

status

enum

The status of the WorkflowStepRun.

One of: PENDING, PROCESSING, PROCESSED, FAILED

output

object

The output of the WorkflowStepRun. The shape of the output depends on the type of the WorkflowStep in the step field below.

EXTERNAL_DATA_VALIDATION

properties

The output will be the same object that was returned by the external endpoint configured for this step.

RULE_VALIDATION

properties

valid

boolean

Indicates whether the entire validation step passed. This field will only be true if every validation rule passed.

rules

object[]

properties

name

string

The name of the validation rule.

valid

boolean

Indicates whether this validation rule passed or not. This field will be true only if the formula evaluates to true. If the rule’s formula is array valued, then this field will only be true if the formula evaluates to true for every item in the array.

validArray

string[]

Only present if the validation rule’s formula is array valued. This field contains the formula’s evaluated result for every item in the array.

failureReason

enum

If the validation rule is not valid, then this describes why the rule failed.

RULE_FAILED: The formula evaluated to false or null.

PARSE_ERROR: The formula could not be parsed.

VALUE_ERROR: An error occurred while evaluating the formula.

error

string

If the failureReason is PARSE_ERROR or VALUE_ERROR, then this field contains the error’s details.

step

WorkflowStep

A WorkflowStep object.

properties

object

string

The type of response, in this case it will always be “workflow_step”.

string

The unique identifier of the WorkflowStep.

name

string

The name of the WorkflowStep.

type

enum

The name of the WorkflowStep. One of: EXTERNAL_DATA_VALIDATION, RULE_VALIDATION

1	{
2	"object": "workflow_run",
3	"id": "workflow_run_1234",
4	"status": "PROCESSED",
5	"metadata": {
6	"internal_id": "id_1234"
7	},
8	"initialRunAt": "2023-01-01T09:41:00.000Z",
9	"reviewedBy": "user_1234",
10	"reviewedAt": "2023-01-10T05:39:14.500Z",
11	"startTime": "2023-01-01T09:41:00.000Z",
12	"endTime": "2023-01-10T05:39:24.500Z",
13	"outputs": [
14	{
15	"object": "document_processor_run",
16	"id": "dpr_1234",
17	"edited": true,
18	"type": "EXTRACT",
19	"initialOutput": {
20	// Output object - see “Processor output types” for details
21	},
22	"reviewedOutput": {
23	// Output object - see “Processor output types” for details
24	},
25	"output": {
26	// Output object - see “Processor output types” for details
27	}
28	}
29	],
30	"stepRuns": [
31	{
32	"object": "workflow_step_run",
33	"id": "step_run_5UUwMs8baKLE5yFS8-0yK",
34	"status": "PROCESSED",
35	"output": {
36	"externalConfidence": 0.8,
37	"requiresHumanReview": true
38	},
39	"step": {
40	"object": "workflow_step",
41	"id": "step_abolADNNmLcOlTtuxDvle",
42	"name": "externalDataValidation1",
43	"type": "EXTERNAL_DATA_VALIDATION"
44	}
45	},
46	{
47	"object": "workflow_step_run",
48	"id": "step_run_OjueNCarlQNpkYfnFkD-A",
49	"status": "PROCESSED",
50	"output": {
51	"valid": false,
52	"rules": [
53	{
54	"name": "invoice_number_present",
55	"valid": true
56	},
57	{
58	"name": "line_item_amount",
59	"valid": true,
60	"validArray": [
61	true,
62	true
63	]
64	},
65	{
66	"name": "vendor_number_present",
67	"valid": false,
68	"failureReason": "RULE_FAILED"
69	}
70	]
71	},
72	"step": {
73	"object": "workflow_step",
74	"id": "step_Q1POO8orTTWgX7CmLLvJZ",
75	"name": "validation1",
76	"type": "RULE_VALIDATION"
77	}
78	}
79	],
80	"workflow": {
81	"object": "workflow",
82	"id": "workflow_1234",
83	"version": "1",
84	"name": "test_workflow"
85	}
86	}