Skip to content
Plune Plune Docs

What the plan collects right now

GET
/v1/plans/{id}/cases
 
curl --request GET \
  --url https://beta-api.plune.ai/v1/plans/example/cases \
  --header 'Authorization: Bearer <token>'

The union of the plan’s collections, then the kind’s rule: a manual plan keeps manual cases (and automated ones when asManual), automated keeps automated, mixed both; evals never. Tree order, no duplicates, deleted cases excluded. This is the list a launch turns into expected, and the list plune plan grep joins into a reporter filter.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The cases

Media type application/json
object
cases
required

Tree order, no duplicates — a case two collections both match is listed once.

Array<object>

A case as the plan lists it — what a run needs of it, and the keys a reporter greps by.

object
id
required
string format: uuid
title
required
string
type
required
string
Allowed values: manual automated eval
priority
required
string
Allowed values: low normal important high critical
state
required
string
Allowed values: draft in_review active detached deprecated
suiteId
required
string
nullable
externalKeys
required
Array<object>

An identifier another tool already uses for this test, so a report can find its case without anyone typing a Plune id. The order of kind is load-bearing: it is the ranking that decides which key wins when several match different cases.

object
kind
required
string
Allowed values: playwright-id path-title allure-history cairn-stable eval-id qase testrail
value
required
string
<= 1024 characters
assigneeId
required

Who holds it now (B8-team T4) — what assignment: prefer-assignee copies at launch.

string
nullable
count
required
integer
Example 
{
  "cases": [
    {
      "id": "6f1c2b3a-0000-4000-8000-0000000000c1",
      "title": "Checkout — empty cart @smoke @checkout",
      "type": "automated",
      "priority": "high",
      "state": "draft",
      "suiteId": "6f1c2b3a-0000-4000-8000-0000000000a1",
      "externalKeys": [
        {
          "kind": "path-title",
          "value": "e2e/checkout.spec.ts > Checkout — empty cart"
        }
      ]
    }
  ],
  "count": 1
}

401

Section titled “401 ”

No / invalid token or session

404

Section titled “404 ”

No such plan in your projects

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