TGM Expert provides comprehensive asset management for hydro and energy facilities, including locations, units, components, and full lifecycle tracking.

Table of Contents¶

• Overview
• Asset Hierarchy
• Locations/Plants
• Units
• Components
• Asset Lifecycle
• Custom Fields

Overview¶

Asset Model¶

Company
  └── Location/Plant
        └── Unit (Turbine, Generator)
              └── Component Group
                    └── Component
                          └── Sub-Assembly

Key Features¶

• Hierarchical Structure - Organize assets in a logical tree
• Custom Properties - Define custom fields per asset type
• Lifecycle Tracking - Track from acquisition to disposal
• Document Linking - Attach drawings, manuals, and files
• Maintenance History - Link inspections, interventions, failures

Asset Hierarchy¶

Hierarchy Levels¶

Navigation¶

# Get all locations for a company
GET /api/locations?companyId=1

# Get units at a location
GET /api/units?locationId=10

# Get components in a unit
GET /api/components?unitId=100

Locations/Plants¶

Location Entity¶

{
  "id": 1,
  "name": "LG-2 Power Station",
  "code": "LG2",
  "type": "HYDRO_PLANT",
  "address": "123 River Road",
  "city": "La Grande",
  "province": "Quebec",
  "country": "Canada",
  "latitude": 53.7888,
  "longitude": -77.0468,
  "timezone": "America/Montreal",
  "capacity": 5328,
  "capacityUnit": "MW",
  "status": "OPERATIONAL",
  "commissionedDate": "1979-10-27",
  "company": {
    "id": 1,
    "name": "Hydro Quebec"
  }
}

Location Types¶

API Endpoints¶

Create Location¶

curl -X POST https://api.tgm-expert.com/api/locations \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Power Station",
    "code": "NPS",
    "type": "HYDRO_PLANT",
    "companyId": 1,
    "latitude": 45.5017,
    "longitude": -73.5673,
    "status": "CONSTRUCTION"
  }'

Units¶

Unit Entity¶

{
  "id": 100,
  "name": "Turbine Unit 1",
  "code": "TU-001",
  "serialNumber": "SN-2024-001",
  "type": "FRANCIS_TURBINE",
  "manufacturer": "GE Hydro",
  "model": "Francis F450",
  "capacity": 150,
  "capacityUnit": "MW",
  "status": "OPERATIONAL",
  "commissionedDate": "1985-06-15",
  "location": {
    "id": 1,
    "name": "LG-2 Power Station"
  },
  "specifications": {
    "headDesign": 137,
    "flowDesign": 290,
    "speedRated": 128.6,
    "runnerDiameter": 5.8
  }
}

Unit Types¶

Unit Status¶

API Endpoints¶

Create Unit¶

curl -X POST https://api.tgm-expert.com/api/units \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Turbine Unit 5",
    "code": "TU-005",
    "type": "FRANCIS_TURBINE",
    "locationId": 1,
    "manufacturer": "GE Hydro",
    "model": "Francis F450",
    "capacity": 150,
    "status": "INSTALLATION"
  }'

Components¶

Component Entity¶

{
  "id": 1000,
  "name": "Governor Valve",
  "code": "GV-001",
  "serialNumber": "GV-2020-0001",
  "type": "VALVE",
  "manufacturer": "Voith",
  "model": "GV-500",
  "status": "OPERATIONAL",
  "installedDate": "2020-03-15",
  "warrantyExpires": "2025-03-15",
  "unit": {
    "id": 100,
    "name": "Turbine Unit 1"
  },
  "componentGroup": {
    "id": 10,
    "name": "Hydraulic System"
  },
  "specifications": {
    "diameter": 500,
    "pressure": 100,
    "material": "Stainless Steel"
  },
  "maintenanceInterval": 365,
  "lastMaintenanceDate": "2025-01-15"
}

Component Status¶

Component Groups¶

Group related components for easier management:

{
  "id": 10,
  "name": "Hydraulic System",
  "description": "Turbine hydraulic control system",
  "unitId": 100
}

API Endpoints¶

Create Component¶

curl -X POST https://api.tgm-expert.com/api/components \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pressure Sensor PS-101",
    "code": "PS-101",
    "type": "SENSOR",
    "unitId": 100,
    "componentGroupId": 10,
    "manufacturer": "Honeywell",
    "model": "STD700",
    "status": "OPERATIONAL"
  }'

Asset Lifecycle¶

Track the complete lifecycle of assets from acquisition to disposal.

Lifecycle Stages¶

Lifecycle Entity¶

{
  "id": 1,
  "component": {
    "id": 1000,
    "name": "Governor Valve"
  },
  "currentStage": "OPERATIONAL",
  "acquisitionDate": "2020-01-15",
  "acquisitionCost": 150000.00,
  "installedDate": "2020-03-15",
  "commissionedDate": "2020-04-01",
  "expectedLifeYears": 25,
  "expectedEndOfLife": "2045-04-01",
  "currentBookValue": 120000.00,
  "depreciationMethod": "STRAIGHT_LINE",
  "healthScore": 85,
  "reliabilityScore": 92.5,
  "mtbf": 8760,
  "mttr": 24,
  "totalFailures": 2,
  "totalDowntimeHours": 48
}

API Endpoints¶

Stage Transition¶

curl -X POST "https://api.tgm-expert.com/asset-lifecycle/1/transition?newStage=DEGRADED" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Vibration levels increasing, scheduled for refurbishment"
  }'

Health Assessment¶

curl -X POST https://api.tgm-expert.com/asset-lifecycle/1/assess \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "healthScore": 75,
    "reliabilityScore": 88.5,
    "notes": "Minor wear detected on seals"
  }'

Lifecycle Dashboard¶

curl -X GET https://api.tgm-expert.com/asset-lifecycle/dashboard \
  -H "Authorization: Bearer $TOKEN"

Response:

{
  "data": {
    "totalAssets": 500,
    "byStage": {
      "OPERATIONAL": 450,
      "DEGRADED": 30,
      "MAINTENANCE": 15,
      "DECOMMISSIONED": 5
    },
    "averageHealthScore": 82,
    "assetsApproachingEndOfLife": 12,
    "assetsRecommendedForReplacement": 5,
    "totalAssetValue": 25000000
  }
}

Custom Fields¶

Define custom fields for any asset type.

Custom Field Definition¶

curl -X POST https://api.tgm-expert.com/api/custom-field-definitions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "runner_material",
    "displayName": "Runner Material",
    "entityType": "Component",
    "fieldType": "SELECT",
    "options": ["Bronze", "Stainless Steel", "Carbon Steel"],
    "isRequired": false,
    "isSearchable": true
  }'

Field Types¶

Using Custom Fields¶

Custom fields are stored in the customFields property:

{
  "id": 1000,
  "name": "Governor Valve",
  "customFields": {
    "runner_material": "Stainless Steel",
    "last_calibration_date": "2025-01-15",
    "criticality_level": "High"
  }
}

Filtering and Search¶

Filter Parameters¶

# Filter by status
GET /api/components?status=OPERATIONAL

# Filter by type
GET /api/units?type=FRANCIS_TURBINE

# Filter by location
GET /api/units?locationId=1

# Filter by date range
GET /api/components?installedAfter=2020-01-01&installedBefore=2024-12-31

# Search by name
GET /api/components?search=valve

# Multiple filters
GET /api/components?unitId=100&status=OPERATIONAL&type=VALVE

Sorting¶

# Sort by name ascending
GET /api/units?sort=name&order=ASC

# Sort by created date descending
GET /api/units?sort=createdAt&order=DESC

Pagination¶

GET /api/units?page=1&pageSize=25

Response includes pagination metadata:

{
  "data": [...],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 10,
      "total": 250
    }
  }
}