Get a revision's effective test plan

GET

/revisions/{id}/effective-test-plan

const url = 'https://app.buildtrace.eu/api/revisions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/effective-test-plan';
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://app.buildtrace.eu/api/revisions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/effective-test-plan \
  --header 'Authorization: Bearer <token>'

Get the final test plan in force for a revision: its own, or the one carried by the latest-effective PROCESS/BOTH ECO that set one. testPlan is absent when the revision has no final test.

Required scope: production:read.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

application/json

object

testPlan

object

Absent on a plan seeded for an ECO that has not saved its own.

string format: uuid

version

required

Counts saves of this plan; 0 for a seeded plan not yet saved.

integer

checks

required

Array<object>

One check of a final test. MEASUREMENT records a number against a minimum and/or maximum (at least one) in a unit, with an optional target; PASS_FAIL records a yes/no outcome; TEXT records a value that is kept but not judged. Names are unique within a plan.

object

kind

required

string

Allowed values: MEASUREMENT PASS_FAIL TEXT

name

required

string

<= 120 characters

unit

Required for a measurement; not allowed otherwise.

string

<= 40 characters

lowerLimit

number format: double

upperLimit

number format: double

target

Nominal value, shown to the operator; must lie within the limits.

number format: double

required

Defaults to true. An optional check may be left blank; if recorded, it still counts.

boolean

instructions

string

<= 1000 characters

ecoNumber

The ECO whose plan is in force; absent when the revision’s own plan applies.

string

ecoTitle

string

effectiveDate

string format: date-time

Example

{
  "testPlan": {
    "checks": [
      {
        "kind": "MEASUREMENT"
      }
    ]
  }
}

401

Unauthorized

404

Not found