Skip to navigation

Cancel an eval run and clean up

View as Markdown

Stops the run, tears down the configuration copy ported for it and releases the PurpleSuite instances it provisioned. lifecycle.status becomes EVAL_RUN_STATUS_CANCELED at once; lifecycle.phase reads EVAL_RUN_PHASE_CLEANING_UP while lifecycle.cleanup.status is CLEANUP_STATUS_RUNNING, and lifecycle.cleanup.status then reports the outcome, including anything that could not be removed; lifecycle.finished_at is set once cleanup is terminal. A run canceled before anything was ported reports CLEANUP_STATUS_SUCCEEDED at once. Cleanup has no deadline: a cleanup that Moveworks could not start stays CLEANUP_STATUS_RUNNING until an operator restarts it. The run stops counting toward the active-run limits at once, when it becomes canceled. Your live configuration was never modified, so there is nothing else to undo.

A run that is EVAL_RUN_STATUS_COMPLETED or EVAL_RUN_STATUS_FAILED answers 409. Cancelling an EVAL_RUN_STATUS_CANCELED run is a no-op (200). Visible to the credential’s user that created the run and to the eval admins Moveworks designates for the org; any other id answers 404.

Authentication

AuthorizationBearer

OAuth 2.0 client-credentials bearer from POST /oauth/v1/token (same as the Conversations API). The token is issued to one org and bound to one user; the run executes in that org and its conversations run as that user. If the eval config names a source_org, it must be the same org. An org that is not enabled for the Eval API sees 404 NOT_FOUND (“API not found”) on every route. An enabled org whose credential is not entitled to run evals receives 403 REQUEST_ACCESS_DENIED. submitted_by.email_addr is the email of the user the credential is bound to.

Path parameters

eval_run_idstringRequired
The run id returned by the submit call.

Response

Canceled, or already canceled and unchanged; the body is the run. cleanup.status is CLEANUP_STATUS_RUNNING until the teardown of the ported copy reports; poll GET for the outcome.

metadataobject

What a run is, fixed when the submission is accepted; a validate_only preview carries it without id.

lifecycleobjectOptional

What moves while the run executes; absent on a validate_only preview.

warningslist of objectsOptional

Non-blocking findings about the run, the twin of the validation issues[]. Absent when there are none, never null, never changes lifecycle.status. Carried on the create (202, or 200 on a validate_only dry run) and on the get, list and cancel responses; findings a pipeline step records later are merged in on later reads.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error