Skip to main content
GET
List equipment specifications

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"]):

  • "specification-values": Adds values (the active values of each specification).
  • "actions-info": Projects { canBeUpdated, canBeDeleted }.
  • "updatable-fields": Per-field write rules for each specification in its current state.
Available options:
specification-values,
actions-info,
updatable-fields
orderBy
object[]

Case-insensitive search across the name and its value names.

Maximum string length: 200
Example:

"lobby"

whereName
string

Case-insensitive partial match on the name.

Maximum string length: 200
Example:

"lobby"

whereValueNames
string

Case-insensitive partial match on a value name.

Maximum string length: 200
Example:

"lobby"

whereITIds
string<uuid>[]

Narrow to the requested technical installations.

Maximum array length: 250
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)$
Example:
whereUnitIds
string<uuid>[]

Narrow to specifications whose technical installation covers the given units.

Maximum array length: 250
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)$
Example:
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