Test

Record an objective check

Changed on

Records whether the steps of one test version satisfy its objective summary, as a new check that becomes the version's current verdict. The test version itself is not changed. Who checked it comes from the caller's credentials. An agent may only record aligned or drifted, and only when the current check is missing or was recorded by an agent. accepted_gap is for people only and needs a gap. Re-sending the current verdict records nothing and returns the current check.

post/test/journeys/{id}/versions/{version}/objectiveCheck

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/test/journeys/{id}/versions/{version}/objectiveCheck
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idstring required

The test invariant ID

versioninteger required

The version of the test the check judges

Request body

state'aligned' | 'drifted' | 'accepted_gap' required

aligned means the steps satisfy the summary; drifted means they fall short, with the difference in gap; accepted_gap means a person saw that gap and chose to keep it.

gapstring

How the steps fall short of the summary. Required for accepted_gap, optional for drifted, and dropped for aligned.

Response

The request matched the current check, so nothing was recorded

idstring
workspace_idstring
test_invariant_idstring

The test invariant ID

test_versioninteger
state'aligned' | 'drifted' | 'accepted_gap'

aligned means the steps satisfy the summary; drifted means they fall short, with the difference in gap; accepted_gap means a person saw that gap and chose to keep it.

gapstring

When state is drifted or accepted_gap, how the steps fall short of the summary.

checked_timeinteger

When the check was recorded, in epoch milliseconds.

checked_by_type'user' | 'agent'

Who authored the objective summary.

checked_by_idstring

The ID of the user or API key that recorded the check.

checked_by_agent_session_idstring

The agent session that recorded the check, when an agent did.

Changes

  • b602223aa51fRevision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 91ff383fb7f9Revision changes
    • info

      endpoint added