The Steps Database — every step of the project with its usage count

GET

/v1/settings/steps

const url = 'https://beta-api.plune.ai/v1/settings/steps';
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/steps \
  --header 'Authorization: Bearer <token>'

Testomat’s Steps Database, as a list: every * line under ## Steps of a live manual case is a row here, written on the case’s save (D10), plus the steps made by hand. count is the live cases carrying the step — a soft-deleted case (D21) drops out of it, a restored one comes back. Ordered case-insensitively by text, then verbatim. q narrows to steps that START with it, case-insensitively — the autocomplete of the case form asks this way.

Authorizations

bearerAuth
cookieAuth

Parameters

Query Parameters

string

A prefix of the step text. Blank or absent means every step.

Responses

200

The steps

application/json

object

steps

required

Array<object>

One row of the Steps Database: the text of an action as manual cases carry it, with how many live cases carry it. Rows are written on every save of a manual case — each * line under ## Steps becomes one — and by hand here.

object

required

string format: uuid

step

required

The action, trimmed. Unique within the project, case-sensitively.

string

>= 1 characters <= 1000 characters

description

A note for the author — what the step means, how to do it. Absent when there is none.

string

count

required

Live cases carrying the step. 0 for a step made by hand that no case uses yet, or orphaned by an edit.

integer

Example

{
  "steps": [
    {
      "id": "6f1c2b3a-0000-4000-8000-0000000000f0",
      "step": "Enter ${Amount} and confirm.",
      "count": 1
    },
    {
      "id": "6f1c2b3a-0000-4000-8000-0000000000f1",
      "step": "Sign in as the shop owner.",
      "description": "The owner account of the demo shop; its credentials are in the team vault.",
      "count": 0
    }
  ]
}

401

No / invalid token or session