Skip to content

Change a manual mark

PATCH
/v1/results/{id}
curl --request PATCH \
--url https://beta-api.plune.ai/v1/results/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "status": "passed", "errorContext": null, "steps": [ { "index": 0, "status": "passed" }, { "index": 1, "status": "passed" }, { "index": 2, "status": "passed" } ] }'

The «To run» section of the run page (D34, api.ts → patchResult): a person who marked a case changes the mark — its status, its message, its steps — in place, while the run is open. Only a result with source: manual answers: a reporter’s result is evidence, and a run of 40 cases must not count 41 because one mark was corrected. Audited under the run. A patch never sets or changes failure; the message is sanitized like a submission’s. The sub-status (#1231) is set here too, after the status — the status button is the submit, and the sub-status follows it in a request of its own.

id
required
string
Media type application/json

At least one key. Only a result with source: manual in an open run takes a patch — a reporter’s result is evidence and stands (404), and a closed run keeps its marks (409). outcome is recomputed from the new status.

object
status
string
Allowed values: passed failed broken blocked skipped
errorContext

null clears the message; redacted and truncated like a submission’s.

string
nullable
steps
Array<object>
nullable <= 200 items
object
index
required

The step’s position in the case’s steps, from 0.

integer
status
required
string
Allowed values: passed failed skipped blocked
subStatus

One of the sub-statuses the result’s status offers now — the built-ins, then the project’s own (GET /v1/settings/sub-statuses); any other is a 400 that names them. null clears it. A new status without one drops the old sub-status, which belonged to the old status.

string
nullable <= 40 characters
files

The ids of files added to the case while the mark was being changed (#1234, POST /v1/runs/{id}/cases/{caseId}/files): they join the files the result already has. Only finished files of this run and this case are taken; any other id is passed over.

Array<string>
<= 30 items
Example
{
"status": "passed",
"errorContext": null,
"steps": [
{
"index": 0,
"status": "passed"
},
{
"index": 1,
"status": "passed"
},
{
"index": 2,
"status": "passed"
}
]
}

The result as it is now

Media type application/json

One stored result, as every reader returns it — a run’s results, a test’s history, a corrected mark.

object
resultKey

The key the reporter sent (a person’s mark: manual:<caseId>). A result a retest replaced (#1767) keeps it with #retest:<id> appended, in its history.

string
combination

The number of the result’s combination in its run’s combinations (#1251, ADR 0070). Absent for a result of a run without configurations.

integer
status

What happened, as it happened — a muted case’s failure is still failed here, and ?status=failed finds it.

string
Allowed values: passed failed broken blocked skipped
muted

Whether the case was muted when this result counted (#1247): stamped from the case when the result is written (a reporter, plune sync, a Cairn ingest), and following the case while the run is open. A failed or broken result of a muted case is counted as muted, not as a failure; a finished run never changes (#1247).

boolean
subStatus

The sub-status a person marked it with (#1231) — the NAME as it stood then: renaming or removing it under Settings → Statuses changes what is offered next, never this. A built-in is its English name (Product bug); the dashboard shows it in its own language. null for none — every reporter’s result, which never carries one.

string
nullable <= 40 characters
errorContext

Returned sanitized — no colour codes, no credentials — whether it was stored before the rules existed or after.

string
nullable
errorContextMeta

What the platform removed before storing — written whenever something was, even without text; null when nothing ever was.

object
redacted
required

Values replaced by a marker, in the text and in every string of failure, each once. The headline counts only when there is no text — otherwise it repeats a line of it.

integer
truncated
required

Whether the TEXT was cut to 256 KB. A shortened field of failure carries its own ….

boolean
omittedByReporter

Characters the REPORTER cut before sending, as it declared in errorContextOmitted; absent when it said nothing. Not the platform’s cut (truncated).

integer
>= 1
failure

What the reporter said about the failed attempt, or null.

object
headline
string
<= 300 characters
steps
Array<string>
<= 20 items
stepsOmitted

How many steps between the outer and the inner ones were left out. Absent when none were.

integer
>= 1
location
object
file
required

From the repository root in posix form, the way a case’s specRef names it. A path of the machine is refused: absolute, with a drive or a scheme, from a home (~), or climbing out with ...

string
>= 1 characters /^(?![A-Za-z][A-Za-z0-9+.-]*:)(?![\\/~])(?!(?:.*[\\/])?\.\.(?:[\\/]|$)).+$/
line
required
integer
>= 1
column
integer
>= 1
file
string
<= 1000 characters
artifacts
Array
<= 50 items
object
name
required

As the runner named it — screenshot, trace, error-context.

string
>= 1 characters
contentType
string
>= 1 characters
name
string
<= 200 characters
contentType
string
<= 100 characters
artifactsOmitted

How many artifacts past the listed ones there are — all reachable through ciUrl.

integer
>= 1
ciUrl
string format: uri
/^[Hh][Tt][Tt][Pp][Ss]?:///
traceUrl

The link to the result’s trace as the reporter or plune sync sent it (#2981) - absent when none was sent. Plune does not check that it opens.

string format: uri
<= 2048 characters /^[Hh][Tt][Tt][Pp][Ss]:///
defects

The defect links on this result (#1064), oldest first - present on a run’s results list, and only when there is one. A result carries them only if it failed or broke.

Array<object>

A defect (#1064): the address of a ticket somebody already filed, kept beside a case or a failed result. https only, at most 2000 characters; the label is plain text, at most 200, and is shown as text, never as markup. The author is a userId; the dashboard names them from GET /v1/members. No type: Bugs (#1065) will read the same links as external tickets.

object
id
required
string format: uuid
url
required
string
<= 2000 characters /^[Hh][Tt][Tt][Pp][Ss]:///
label
required
string
nullable <= 200 characters
authorId
required
string
createdAt
required
string format: date-time
suitePath

Where the result’s case sits in the tree (#1232) — the suites from the root down to its own; a suite filed from a spec stands for the folders above it by its file (["e2e/cart.spec.ts", "Coupons"]). Empty for a case at the root. On a run’s results list, always.

Array<string>
title

The title of the result’s case (#1705), so a page can name its rows without reading the project’s case list. On a run’s results list; kept after the case is deleted, like the rest of the evidence.

string
files

Files uploaded to this result — screenshots, text (JSON, plain text, logs) and, for a project with a bucket, any file — oldest first (ADR 0040, ADR 0041) — present on a run’s results list, and only when there is one. Only finished files: one still waiting for complete is not listed. For storage: db the bytes are GET /v1/files/{id}.

Array<object>

A file of a result, everything but its bytes (ADR 0040, ADR 0041). Only a finished file is ever shown: one that was announced with uploads and not yet completed is in no list.

object
id
required
string
name
required

The last segment of the name it was uploaded with, cleaned of credentials as a text is.

string
contentType
required

In the database (storage: db): image/png, image/jpeg, image/webp, application/json or text/plain — a log is text/plain. In the bucket (storage: bucket): the media type it was announced with, lower case and without parameters, any type.

string
size
required

Bytes as kept: in the database a picture at most 2 MiB and a text at most 512 KiB, counted after its credentials are cleaned, so it can differ from what was sent; in the bucket the size that was announced and found there.

integer
storage
required

db: Plune keeps the bytes in its database, GET /v1/files/{id} returns them. bucket: they are in a bucket — the project’s own, or, for a built-in file of a server that keeps those in its own bucket (#1428), Plune’s — and GET /v1/files/{id} answers 409 in_bucket (the way to read them is GET /v1/files/{id}/link). A built-in file in Plune’s bucket counts toward the budget as one in the database does.

string
Allowed values: db bucket
evictedFiles

#1444: the files of this result the built-in storage sent away to make room (ADR 0040) - their name, type, size and when, oldest first; the bytes are gone. On a run’s results list, and only when there is one.

Array<object>
object
name
required
string
contentType
required
string
size
required
integer
evictedAt
required
string format: date-time
key
additional properties
any
Example
{
"id": "6f1c2b3a-0000-4000-8000-0000000000e1",
"runId": "6f1c2b3a-0000-4000-8000-0000000000d1",
"testCaseId": "6f1c2b3a-0000-4000-8000-0000000000c1",
"resultKey": "manual:6f1c2b3a-0000-4000-8000-0000000000c1",
"signature": "7f974c61f8f10065cd8ae6993cc069e4f85b1db1ed008b965885fb6f945a28c9",
"status": "passed",
"rawStatus": null,
"source": "manual",
"expectedStatus": "passed",
"outcome": "expected",
"execution": null,
"durationMs": null,
"caseVersion": 1,
"muted": false,
"errorContext": null,
"errorContextMeta": null,
"assertions": [],
"steps": [
{
"index": 0,
"status": "passed"
},
{
"index": 1,
"status": "passed"
},
{
"index": 2,
"status": "passed"
}
],
"failure": null,
"executedBy": null,
"subStatus": null,
"createdAt": "2026-09-16T09:12:04.151Z"
}

Invalid body, nothing to change, or a sub-status the status does not offer — the message names the ones it does

Media type application/json
object
error
required
string
Example
{
"error": "'Nope' is not a sub-status of failed — it has Product bug, Environment issue"
}

No / invalid token or session

No such manual result in your projects — a reporter’s result reads as not found

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

The run is closed

Media type application/json
object
error
required
string
Example
{
"error": "the run is closed — its results stand"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over