Expectation Evaluations

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

List Expectation Evaluations

SDK Method

Files::ExpectationEvaluation.list

Return Object

List<ExpectationEvaluation>

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

begin
  expectation_evaluations = Files::ExpectationEvaluation.list
  expectation_evaluations.auto_paging_each do |expectation_evaluation|
    # Operate on expectation_evaluation
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Expectation Evaluation

SDK Method

Files::ExpectationEvaluation.find

Return Object

ExpectationEvaluation

Authorization Requirement

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

Method Arguments

ArgumentDescription
id
int64
Required		Expectation Evaluation ID.

Example Request

begin
  expectation_evaluation = Files::ExpectationEvaluation.find(id)
  # Operate on expectation_evaluation
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Manually open an Expectation window

SDK Method

expectation.trigger_evaluation

Return Object

ExpectationEvaluation

Authorization Requirement

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

Example Request

begin
  # Find the expectation object by its id.
  expectation = Files::Expectation.find(id)
  expectation.trigger_evaluation
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The ExpectationEvaluation Object

Some of the methods 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.