Skip to main content
GET
Get an equipment

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required
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)$

Query Parameters

extend
enum<string>[]

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

  • "technical-installation": Adds technicalInstallation (the equipment's technical installation).
  • "unit": Adds unit (the unit the equipment is attached to, nullable).
  • "installed-by": Adds installedBy (the installer provider, nullable).
  • "position": Adds position (the marker on a plan, nullable).
  • "contained-in": Adds containedIn (the zones/rooms this equipment sits in).
  • "specifications": Adds specifications (the specification values tagging this equipment).
  • "qrcode": Adds qrcode (the QR code associated to this equipment, nullable).
  • "qrcodes": Adds qrcodes (every QR code associated to this equipment, by serial number).
  • "counts": Adds counts (anomalies by processing state, tickets, compliances by status, QR codes, responsibilities and interventions attached).
  • "actions-info": Projects { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }.
  • "updatable-fields": Per-field write rules for this equipment in its current state.
  • "responsibles": Adds responsibles - the users responsible for this element.
  • "created-by": Adds createdBy (the user who created this equipment).
Available options:
technical-installation,
unit,
installed-by,
position,
contained-in,
specifications,
qrcode,
qrcodes,
counts,
actions-info,
updatable-fields,
responsibles,
created-by
whereUnitIds
string<uuid>[]

Narrow linked equipments 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 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:

Response

Default Response

id
string<uuid>
required
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)$
ref
string
required
Maximum string length: 40
Pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$
name
string
required
Required string length: 1 - 150
description
string | null
required
Maximum string length: 1000
manufacturer
string | null
required
Required string length: 1 - 100
externalReference
string | null
required
Required string length: 1 - 100
condition
enum<string> | null
required
Available options:
new,
very_good,
good,
average,
bad
availability
enum<string> | null
required
Available options:
in_service,
in_stock,
in_repair,
out_of_service
purchasePrice
number | null
required
Required range: 0 < x <= 999999999.99
replacementValue
number | null
required
Required range: 0 < x <= 999999999.99
technicalInstallationId
string<uuid>
required
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)$
unitId
string<uuid> | null
required
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)$
installedById
string<uuid> | null
required
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)$
installedAt
string<date-time> | null
required
constructedAt
string<date-time> | null
required
archivedAt
string<date-time> | null
required
deletedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
technicalInstallation
object
unit
object | null
installedBy
object | null
position
object | null
containedIn
object[]
specifications
object[]
qrcode
object | null
qrcodes
object[]
counts
object
actions
object
updatableFields
object
responsibles
object[]
createdBy
object