List numbering schemes

GET

/numbering-schemes

const url = 'https://app.buildtrace.eu/api/numbering-schemes';
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/numbering-schemes \
  --header 'Authorization: Bearer <token>'

The organization-wide numbering schemes for the numbers BuildTrace generates: unit serial numbers, build orders and rework orders: always these three, in that order. A scope no number has been drawn from yet shows its default template and next value 1. Lot numbers and device identifiers are entered by hand, so they have no scheme to show.

Required scope: settings:read.

Authorizations

bearerAuth

Responses

200

application/json

Array<object>

object

scope

required

string

Allowed values: SERIAL LOT DEVICE BUILD_ORDER REWORK_ORDER

template

required

Literal text plus tokens: {YYYY} {YY} {MM} and {SEQ} or {SEQ:n} (zero-padded to n digits, 1-9).

string

nextValue

required

The sequence value the next number will use.

integer format: int64

preview

required

The next number, formatted now.

string

maxLength

required

The longest number this scope can store.

integer

Example

[
  {
    "scope": "SERIAL"
  }
]

401

Unauthorized

403

Forbidden