AssetLab System LoS Targets API

openapi: 3.2.0
info:
  title: Assetlab Ca System LoS Targets API
  version: '1.0'
  contact:
    name: AssetLab Support
    url: https://assetlab.ca
    email: support@assetlab.ca
  license:
    name: Proprietary
  description: 'Operations tagged System LoS Targets across 2 of this provider''s published API definitions: assetlab-ca-openapi.yaml, assetlab-ca-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
  description: Production
security:
- BearerAuth: []
tags:
- name: System LoS Targets
  description: Technical level of service target per system and metric; each building is held to a version adjusted by its criticality
paths:
  /system-los-targets:
    get:
      operationId: listSystemLosTargets
      summary: List system LoS targets
      tags:
      - System LoS Targets
      description: Returns base technical level of service targets, one per system and metric, oldest first. Each building is held to a version of the base target adjusted by its criticality. Requires `los_targets:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - name: system_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by system
      - name: metric
        in: query
        schema:
          type: string
          enum:
          - fci
          - asset_condition_avg
          - asset_past_useful_life_pct
          - risk_score_avg
        description: Filter by metric
      - name: active
        in: query
        schema:
          type: boolean
        description: Filter by whether the target is being measured
      responses:
        '200':
          description: Paginated system LoS target list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SystemLosTarget'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    post:
      operationId: createSystemLosTarget
      summary: Create system LoS target
      tags:
      - System LoS Targets
      description: The system_id must reference an existing system. `direction` is derived from the metric and is never accepted. Requires `los_targets:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemLosTargetCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SystemLosTarget'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: This system already has a target for this metric
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /system-los-targets/{id}:
    get:
      operationId: getSystemLosTarget
      summary: Get system LoS target by ID
      tags:
      - System LoS Targets
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: System LoS target detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SystemLosTarget'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateSystemLosTarget
      summary: Update system LoS target
      tags:
      - System LoS Targets
      description: Changing `metric` re-derives `direction`. If the stored base_target falls outside the new metric's scale, send a base_target with it. Requires `los_targets:write` scope.
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemLosTargetUpdate'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SystemLosTarget'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: This system already has a target for this metric
        '429':
          $ref: '#/components/responses/RateLimited'
    delete:
      operationId: deleteSystemLosTarget
      summary: Delete system LoS target
      tags:
      - System LoS Targets
      description: Requires `los_targets:write` scope.
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
components:
  responses:
    Deleted:
      description: Resource deleted
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              message:
                type: string
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request (validation error or malformed input)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    SystemLosTargetUpdate:
      type: object
      properties:
        system_id:
          type: string
          format: uuid
        metric:
          type: string
          enum:
          - fci
          - asset_condition_avg
          - asset_past_useful_life_pct
          - risk_score_avg
          description: Changing the metric re-derives direction. Send a base_target too when the stored one does not fit the new scale
        base_target:
          type: number
          minimum: 0
          maximum: 100
          description: 'On the scale of the metric in force (not money): 0-100, or 0-25 for risk_score_avg'
        active:
          type: boolean
    SystemLosTargetCreate:
      type: object
      required:
      - system_id
      - metric
      - base_target
      properties:
        system_id:
          type: string
          format: uuid
        metric:
          type: string
          enum:
          - fci
          - asset_condition_avg
          - asset_past_useful_life_pct
          - risk_score_avg
        base_target:
          type: number
          minimum: 0
          maximum: 100
          description: 'On the metric''s scale (not money): 0-100, or 0-25 for risk_score_avg'
        active:
          type: boolean
          default: true
    Pagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 25
        total:
          type: integer
          example: 142
        total_pages:
          type: integer
          example: 6
    Error:
      type: object
      properties:
        error:
          type: string
          example: Asset not found
    SystemLosTarget:
      type: object
      description: 'One base target per system and metric, set once for the organization. Each building is

        held to a version adjusted by its criticality: a lower-is-better target is multiplied by

        the tier''s modifier, a higher-is-better one keeps its distance from a perfect score

        multiplied by it (condition 70 becomes 82 at a Critical facility, 58 at a Low one).

        Derived targets never leave the metric''s scale.

        '
      properties:
        id:
          type: string
          format: uuid
        tenant_id:
          type: string
        system_id:
          type: string
          format: uuid
        metric:
          type: string
          enum:
          - fci
          - asset_condition_avg
          - asset_past_useful_life_pct
          - risk_score_avg
          description: fci, asset_condition_avg and asset_past_useful_life_pct run 0-100; risk_score_avg runs 0-25. asset_condition_avg uses the fixed 0-100 condition bands
        base_target:
          type: number
          minimum: 0
          maximum: 100
          description: 'Organization-wide base on the metric''s scale (not money): 0-100, or 0-25 for risk_score_avg'
        direction:
          type: string
          enum:
          - higher_is_better
          - lower_is_better
          readOnly: true
          description: 'Derived from the metric and never accepted from the caller: asset_condition_avg is higher_is_better, the other three are lower_is_better'
        active:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Resource UUID
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
      description: Page number
    per_page:
      name: per_page
      in: query
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 1000
      description: Items per page
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key from AssetLab Settings > API Keys
x-refined-from:
- assetlab-ca-openapi.yaml
- assetlab-ca-openapi.yaml
x-tagGroups:
- name: Core
  tags:
  - Assets
  - Work Orders
  - Work Requests
  - PM Schedules
  - PM Templates
- name: Facilities
  tags:
  - Sites
  - Buildings
  - Locations
- name: Feature Classification
  tags:
  - Systems
  - System Groups
  - System Classes
  - Asset Types
  - Asset Type Groups
  - Manufacturers
- name: Projects
  tags:
  - Projects
  - Project Sites
  - Project Buildings
  - Project Locations
  - Project System Classes
  - Project System Groups
  - Project Systems
  - Project Assets
  - Project Tasks
  - Project Milestones
  - Project Phases
  - Project Budget Items
  - Project Time Entries
  - Project Comments
  - Project Risks
  - Project Document Folder Templates
- name: Financial
  tags:
  - Budgets
  - Invoices
  - Purchase Orders
  - Expenses
  - Change Orders
  - Cost Categories
  - Asset Costs
  - Asset Replacement Plans
- name: Vendors & Contracts
  tags:
  - Vendors
  - Contracts
  - Vendor Site Assignments
  - Contract Sites
- name: Compliance
  tags:
  - Compliance
  - Compliance Records
- name: Parts & Inventory
  tags:
  - Parts
  - Part Categories
- name: Comments & Documents
  tags:
  - Asset Comments
  - Work Order Comments
  - Asset Documents
  - Project Documents
  - Contract Documents
  - Attachments
  - Upload URLs
- name: Level of Service
  tags:
  - Service Areas
  - Service Area System Classes
  - Service Area Sites
  - LoS Measures
  - LoS Measurements
  - LoS Proposed Targets
  - LoS Targets History
  - System LoS Targets
  - Infrastructure LoS Targets
  - Criticality Modifiers
  - LoS Consequences
  - LoS Status Snapshots
- name: Infrastructure
  tags:
  - Infrastructure Feature Classes
  - Infrastructure Networks
  - Infrastructure Assets
  - Infrastructure Asset Inspections
- name: Dashboard & Analytics
  tags:
  - Dashboard
  - Dashboard Snapshots
  - Site FCI History
  - Asset Risk History
  - Asset Condition Assessments
- name: Configuration
  tags:
  - Asset Statuses
  - Work Categories
  - Building Types
  - Location Types
  - Custom Field Definitions
  - Custom Field Values