List units

GET

/serials

const url = 'https://app.buildtrace.eu/api/serials?limit=50&offset=0';
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/serials?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Required scope: inventory:read.

Authorizations

bearerAuth

Parameters

Query Parameters

status

string

currentLocationId

string format: uuid

partRevisionId

string format: uuid

lot

string

Substring match on serial number

limit

integer

default: 50

offset

integer

Responses

200

application/json

Array<object>

object

required

string format: uuid

partRevisionId

required

string format: uuid

serialNumber

required

string

status

required

string

currentLocationId

string format: uuid

lotNumber

string

consumedIntoSerialId

string format: uuid

reservedForOrderId

string format: uuid

partCode

Code of the serial’s part (read-only; populated by build-order unit reads).

string

partName

Name of the serial’s part (read-only; populated by build-order unit reads).

string

revisionLabel

Label of the serial’s part revision (read-only; populated by build-order unit reads).

string

finalTestResult

The unit’s final-test outcome (read-only; populated by a build order’s units list): its latest FINAL inspection (the one recorded when it was built, or a retest since, which may be CONDITIONAL), else NOT_TESTED when it was built with no final test. Absent when unknown. The as-built record keeps the result at build time.

string

Allowed values: PASS FAIL CONDITIONAL NOT_TESTED

ecoState

Derived ECO status (read-only; populated by list reads). NEEDS_WORK when an ECO targets this serial with no retrofit recorded yet; APPLIED when it has ECO history and nothing outstanding; NONE when no ECO has ever touched it.

string

Allowed values: NEEDS_WORK APPLIED NONE

createdAt

required

string format: date-time

Example

[
  {
    "finalTestResult": "PASS",
    "ecoState": "NEEDS_WORK"
  }
]

401

Unauthorized