The project's sub-statuses, with the results carrying each

GET

/v1/settings/sub-statuses

const url = 'https://beta-api.plune.ai/v1/settings/sub-statuses';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://beta-api.plune.ai/v1/settings/sub-statuses \
  --header 'Authorization: Bearer <token>'

Settings → Statuses (#1231): the words a result can carry under its status — why a case failed, what blocked it. A person picks one when marking a result in a manual run (PATCH /v1/results/{id}), and the run report filters by them (GET /v1/runs/{id}/results?subStatus=). Four come with every project and cannot be renamed or removed — passed: Minor issue; failed: Product bug, Environment issue; blocked: Waiting for a fix. Every role reads them.

Authorizations

bearerAuth
cookieAuth

Responses

200

Per status, the built-ins and then the project’s own

application/json

object

subStatuses

required

Per status in the order passed, failed, broken, blocked, skipped: the built-ins first, then the project’s own in the order the owner set them.

Array<object>

One row of Settings → Statuses (#1231).

object

status

required

string

Allowed values: passed failed broken blocked skipped

name

required

As a result stores it. A built-in’s is its English name; the dashboard shows it in its own language.

string

<= 40 characters

builtIn

required

Comes with every project; nobody renames or removes it.

boolean

results

required

The project’s results that carry this name under this status — a result keeps the name it was marked with, so a renamed one starts at 0.

integer

Example

{
  "subStatuses": [
    {
      "status": "passed",
      "name": "Minor issue",
      "builtIn": true,
      "results": 6
    },
    {
      "status": "failed",
      "name": "Product bug",
      "builtIn": true,
      "results": 9
    },
    {
      "status": "failed",
      "name": "Environment issue",
      "builtIn": true,
      "results": 14
    },
    {
      "status": "failed",
      "name": "Test is outdated",
      "builtIn": false,
      "results": 4
    },
    {
      "status": "blocked",
      "name": "Waiting for a fix",
      "builtIn": true,
      "results": 5
    }
  ]
}

401

No / invalid token or session