Expectation Evaluations

An ExpectationEvaluation records one open or closed window for an Expectation.

List Expectation Evaluations

Command

files-cli expectation-evaluations list

Output

Outputs a list of ExpectationEvaluation objects according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

files-cli expectation-evaluations list

Show Expectation Evaluation

Command

files-cli expectation-evaluations find

Output

Outputs a ExpectationEvaluation object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required
Expectation Evaluation ID.

Example Request

files-cli expectation-evaluations find \
  --id=1

Manually open an Expectation window

Command

files-cli expectations trigger-evaluation

Output

Outputs a ExpectationEvaluation object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required
Expectation ID.

Example Request

files-cli expectations trigger-evaluation \
  --id=1

The ExpectationEvaluation Object

Some of the commands above return a ExpectationEvaluation object. The attributes of this object are listed below.

AttributeDescription
id
int64
ExpectationEvaluation ID
workspace_id
int64
Workspace ID. 0 means the default workspace.
expectation_id
int64
Expectation ID.
status
string
Evaluation status.
Possible values: open, success, late, missing, invalid
opened_via
string
How the evaluation window was opened.
Possible values: schedule, manual, upload
opened_at
date-time
When the evaluation row was opened.
window_start_at
date-time
Logical start of the candidate window.
window_end_at
date-time
Actual candidate cutoff boundary for the window.
deadline_at
date-time
Logical due boundary for schedule-driven windows.
late_acceptance_cutoff_at
date-time
Logical cutoff for late acceptance, when present.
hard_close_at
date-time
Hard stop after which the window may not remain open.
closed_at
date-time
When the evaluation row was finalized.
matched_files
array(object)
Captured evidence for files that matched the window.
missing_files
array(object)
Captured evidence for required files that were missing.
criteria_errors
array(string)
Captured criteria failures for the window, including file-scoped FTS errors and returned validation details.
summary
object
Compact evaluator summary payload.
created_at
date-time
Creation time.
updated_at
date-time
Last update time.