Skip to main content
GET
List technical installations (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"]):

  • "sites": Adds sites (the active sites each installation is present on).
  • "actions-info": Projects { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }.
  • "updatable-fields": Per-field write rules for each installation in its current state.
  • "library-technical-installation": Adds libraryTechnicalInstallation (the library entry this installation was adopted from, for grouping instances by type).
  • "responsibles": Adds responsibles - the users responsible for this element.
  • "created-by": Adds createdBy (the user who created each technical installation).
Available options:
sites,
actions-info,
updatable-fields,
library-technical-installation,
responsibles,
created-by
orderBy
object[]

Case-insensitive search across name and ref.

Maximum string length: 200
Example:

"lobby"

whereName
string

Case-insensitive partial match on the name.

Maximum string length: 200
Example:

"lobby"

whereUnitIds
string<uuid>[]

Narrow linked technical installations to the requested unit ids.

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:
whereITIds
string<uuid>[]

Narrow the result to the requested technical installation ids.

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:
whereArchived

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

Example:

true

whereProvenance

When true, only library-adopted; when false, only org-created.

Example:

true

whereCreatedAt
object

Filter by creation date range.

Example:
whereUpdatedAt
object

Filter by last-update date range.

Example:
whereImResponsible

When true, restricts to technical installations the current user is responsible for - holding a responsibility on the installation itself or on one of the units it serves. Narrows the caller’s visibility scope, never widens it.

Example:

true

whereIncludeDeleted

When true, also returns soft-deleted technical installations.

Example:

true

Response

Default Response

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