Available Operations

Equipments

POST /equipments - Create a new equipment
GET /equipments Retrieve equipment with filtering and pagination
GET /equipments/{id} - Get equipment by ID
PUT /equipments/{id} - Update equipment
DELETE /equipments/{id} - Delete equipment
GET /equipments/external-id/{externalId} - Get equipment by external ID

Brands & Models

GET /brands - Retrieve brands with filtering and pagination
GET /models - Retrieve models with filtering and pagination

Data Models & Schemas

{
  "id": "string",
  "title": "string",
  "invNumber": "string",
  "categoryId": "uuid",
  "category": "Category",
  "modelId": "string",
  "brandId": "string",
  "year": "number",
  "month": "number",
  "articleNr": "string",
  "quickCoupler": "string",
  "operatingHoursTotal": "number",
  "productLine": "string",
  "specifications": "object",
  "weight": "number",
  "additional_specifications": "object",
  "structureId": "string",
  "organizationId": "uuid",
  "externalId": "string",
  "productId": "string",
  "last_client_service": "date-time",
  "beaconId": "string",
  "beaconVendor": "string",
  "RFID": "string",
  "plateNumber": "string",
  "parentId": "string",
  "installation": "object",
  "createdAt": "date-time",
  "special_number": "string",
  "responsible_person": "string",
  "unique_equipment_id": "string",
  "bgl_number": "string",
  "serial_number": "string",
  "inventory": "array",
  "warehouseId": "string",
  "trackingTag": "string",
  "workingHours": "number",
  "updatedAt": "date-time",
  "structureIds": "array",
  "operating_weight": "number",
  "calculating_criteria": "string",
  "workingHoursPrice": "number",
  "calculating_conditions": "object",
  "active": "boolean",
  "inactive": "object",
  "media": "array",
  "subtitle": "string",
  "isSyncedLectura": "boolean",
  "equipmentMedia": "array",
  "typeplateMedia": "array",
  "qrMedia": "array",
  "otherMedia": "array",
  "isChild": "boolean"
}

Field Descriptions:

id - A unique identifier for the equipment record
title - A string representing the title or name of the equipment or item
invNumber - A string representing the inventory number assigned to the item, used for tracking purposes
categoryId - A unique identifier (UUID) for the category to which the equipment belongs
category - Category object with equipment classification details
brandId - Brand identifier (To retrieve the list of brands, use the following endpoint: Brands)
modelId - Model identifier (To retrieve the list of models, use the following endpoint: Models)
year - A number representing the year of the equipment or item's manufacture
month - Manufacturing month
articleNr - Article number
quickCoupler - Quick coupler of the equipment
operatingHoursTotal - A numerical value representing the total operating hours of the equipment
productLine - Product line information
specifications - An object detailing the specifications of the equipment
weight - A numerical value representing the weight of the equipment
additional_specifications - An object for any additional specifications not covered in the primary specifications
structureId - A unique identifier (UUID) for the structure associated with the equipment
organizationId - Organization UUID
externalId - An identifier that connects this record to external systems or databases, facilitating integration with other platforms
productId - Product Id which this equipment belongs to
last_client_service
beaconId - A string for the beacon identifier, if applicable
beaconVendor - A string for the vendor of the beacon associated with the equipment. See available options here
RFID - A string for the RFID tag associated with the equipment
plateNumber - A string fro the plateNumber associated with the equipment
parentId - Parent equipment identifier
installation - Installation information object
createdAt - Timestamp indicating when this equipment was first created in the system
special_number - A string for any special identification number
responsible_person - A string for the name of the person responsible for the equipment
unique_equipment_id - A string for a unique identifier for the equipment
bgl_number - A field for a BGL number
serial_number - A string for the serial number of the equipment
inventory - Array of inventory items
warehouseId - A unique identifier for the warehouse the equipment is assigned to
trackingTag - A string for any tracking tag associated with the equipment. (See available options here)
workingHours - A numerical value representing the total working hours of the equipment
updatedAt - Timestamp of the most recent update to this equipment
structureIds - Array of structure identifiers
operating_weight - Operating weight of the equipment
calculating_criteria - Criteria used for calculations
workingHoursPrice - Price per working hour
calculating_conditions - Conditions for calculations
active - Whether the equipment is active
inactive - if active is false, this field includes the reason, startDate, endDate and description
media - Array of media files
subtitle - A string for any subtitle associated with the equipment
isSyncedLectura - Whether synced with Lectura system
equipmentMedia - Array of equipment-specific media
typeplateMedia - Array of typeplate media
qrMedia - Array of QR code media
otherMedia - Array of other media files
isChild - Whether this is a child equipment

Brand

{
  "id": "53f79939-37ff-4aed-bd7c-a117009e18cd",
  "name": "Caterpillar",
  "createdAt": "2025-12-09T22:25:22.663Z",
  "updatedAt": "2025-12-09T22:25:22.663Z",
  "deletedAt": null
}

Model

{
  "id": "fd64cc1f-6059-43f1-a738-366bc5c60aac",
  "name": "120",
  "brand": {
    "id": "53f79939-37ff-4aed-bd7c-a117009e18cd",
    "name": "Caterpillar",
    "createdAt": "2025-12-09T22:25:22.663Z",
    "updatedAt": "2025-12-09T22:25:22.663Z",
    "deletedAt": null
  },
  "brandId": "53f79939-37ff-4aed-bd7c-a117009e18cd",
  "firstYear": 2019,
  "lastYear": 2022,
  "createdAt": "2022-05-12T09:55:45.122Z",
  "updatedAt": "2022-05-12T09:55:45.122Z",
  "deletedAt": null
}

Field Enums:

beaconVendor:

syniotec-link
syniotec-core
syniotec-edge
syniotec-lite
syniotec-volt
syniotec-dot
syniotec-solar
syniotec-obd
rosenberger-telematics
syniotec-sbox-g2
syniotec-sbox-g3
syniotec-lora-beacon
machinemax-telematics
liebherr-aemp-2.0
caterpillar-aemp-2.0
hitachi-aemp-2.0
volvo-aemp-2.0
trackunit-telematics
zeppelin-cat-aemp-2.0
kubota-aemp-2.0
komatsu-aemp-2.0
trusted-global
syniotec-link-mini
takeuchi-aemp-2.0

trackingTag:

metal
nfc
rqn
chain
custom
syniostickers
qr_sticker
tag_m
tag_s

Error Response DTO

Standard error response format.

{
  "status": "number",
  "success": "boolean",
  "message": "string",
  "error": "string"
}

Field Descriptions:

status - HTTP status code (400-503)
success - Boolean indicating the operation failed (false)
message - Human-readable error message
error - Error code identifier