Expectation Evaluations

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

List Expectation Evaluations

SDK Method

\Files\Model\ExpectationEvaluation::list;

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.

Additional Arguments

Example Request

try {
  $expectation_evaluations = \Files\Model\ExpectationEvaluation::list();
  foreach ($expectation_evaluations as $expectation_evaluation) {
    // Operate on $expectation_evaluation
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Expectation Evaluation

SDK Method

\Files\Model\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

try {
  $expectation_evaluation = \Files\Model\ExpectationEvaluation::find($id);
  // Operate on $expectation_evaluation
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Manually open an Expectation window

SDK Method

$expectation->triggerEvaluation;

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

try {
  // Find the expectation object by its id.
  $expectation = \Files\Model\Expectation::find(id);
  $expectation->triggerEvaluation();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

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.