Expectation Evaluations

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

List Expectation Evaluations

SDK Method

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

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    expectation_evaluation "github.com/Files-com/files-sdk-go/v3/expectationevaluation"
)

expectationEvaluationIterator, err := expectation_evaluation.List(files_sdk.ExpectationEvaluationListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for expectationEvaluationIterator.Next() {
    expectationEvaluation := expectationEvaluationIterator.expectationEvaluation()
}
err = expectationEvaluationIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Show Expectation Evaluation

SDK Method

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.

ExpectationEvaluationFindParams Fields

FieldDescription
Id
int64
Required		Expectation Evaluation ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    expectation_evaluation "github.com/Files-com/files-sdk-go/v3/expectationevaluation"
)

expectationEvaluation, err := expectation_evaluation.Find(files_sdk.ExpectationEvaluationFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

ExpectationTriggerEvaluationParams Fields

FieldDescription
Id
int64
Required		Expectation ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    "github.com/Files-com/files-sdk-go/v3/expectation"
)

expectationEvaluation, err := expectation.TriggerEvaluation(files_sdk.ExpectationTriggerEvaluationParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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
WorkspaceId
int64		Workspace ID. 0 means the default workspace.
ExpectationId
int64		Expectation ID.
Status
string		Evaluation status.
Possible values: open, success, late, missing, invalid
OpenedVia
string		How the evaluation window was opened.
Possible values: schedule, manual, upload
OpenedAt
date-time		When the evaluation row was opened.
WindowStartAt
date-time		Logical start of the candidate window.
WindowEndAt
date-time		Actual candidate cutoff boundary for the window.
DeadlineAt
date-time		Logical due boundary for schedule-driven windows.
LateAcceptanceCutoffAt
date-time		Logical cutoff for late acceptance, when present.
HardCloseAt
date-time		Hard stop after which the window may not remain open.
ClosedAt
date-time		When the evaluation row was finalized.
MatchedFiles
array(object)		Captured evidence for files that matched the window.
MissingFiles
array(object)		Captured evidence for required files that were missing.
CriteriaErrors
array(string)		Captured criteria failures for the window, including file-scoped FTS errors and returned validation details.
Summary
object		Compact evaluator summary payload.
CreatedAt
date-time		Creation time.
UpdatedAt
date-time		Last update time.