Skip to main content
GET
List library equipment specifications (BO, paginated/filterable)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "library-technical-installation": Adds libraryTechnicalInstallation { id, nameFr, nameEn, nameDe } (the parent catalog TI).
  • "counts": Adds nbInstances (active org EquipmentSpecification rows referencing this entry).
  • "created-by": Adds createdByBoUser { id, name, email } (the BO admin who created this entry).
  • "actions-info": Projects { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted } per row.
Available options:
library-technical-installation,
counts,
created-by,
actions-info
orderBy
object[]

Case-insensitive partial match on the specification name.

Maximum string length: 200
Example:

"lobby"

whereLibraryTechnicalInstallationId
string<uuid>

Filter by the parent library technical installation id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
whereArchived

When true, only archived; when false, only non-archived.

Example:

true

whereCreatedAt
object

Filter by creation date range.

Example:
whereUpdatedAt
object

Filter by last-update date range.

Example:
whereIncludeDeleted

When true, also returns soft-deleted specifications.

Example:

true

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required