AssetLab Floor Plans API

openapi: 3.2.0
info:
  title: Assetlab Ca Floorplans API
  version: '1.0'
  contact:
    name: AssetLab Support
    url: https://assetlab.ca
    email: support@assetlab.ca
  license:
    name: Proprietary
  description: 'Operations tagged Floorplans 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: Floor Plans
paths:
  /floorplans:
    get:
      operationId: listFloorplans
      summary: List floorplans
      tags:
      - Floor Plans
      description: Returns a paginated list of floorplan pages. Filter by `building_id` for a building's floors, or by `site_id` for site-level plans. Requires `floorplans:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - name: building_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by building (building-scoped floorplans)
      - name: site_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by site (site-scoped floorplans only)
      - name: status
        in: query
        schema:
          type: string
          enum:
          - pending
          - detecting
          - ready
          - failed
        description: Filter by detection status
      responses:
        '200':
          description: Paginated floorplan list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Floorplan'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    post:
      operationId: createFloorplan
      summary: Create floorplan row
      tags:
      - Floor Plans
      description: Registers one floor (PDF page) in the database. Does not upload the PDF itself — that happens via Supabase Storage. Requires `floorplans:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FloorplanCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Floorplan'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /floorplans/{id}:
    get:
      operationId: getFloorplan
      summary: Get floorplan by ID
      tags:
      - Floor Plans
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Floorplan detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Floorplan'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateFloorplan
      summary: Update floorplan
      tags:
      - Floor Plans
      description: Requires `floorplans:write` scope.
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FloorplanUpdate'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Floorplan'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteFloorplan
      summary: Delete floorplan
      tags:
      - Floor Plans
      description: Requires `floorplans:write` scope. Cascades to regions and asset placements on this floor.
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /floorplan-regions:
    get:
      operationId: listFloorplanRegions
      summary: List floorplan regions
      tags:
      - Floor Plans
      description: Labeled rooms/zones on a floorplan. Requires `floorplan_regions:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - name: floorplan_id
        in: query
        schema:
          type: string
          format: uuid
      - name: location_id
        in: query
        schema:
          type: string
          format: uuid
      - name: reviewed
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Paginated region list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FloorplanRegion'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createFloorplanRegion
      summary: Create floorplan region
      tags:
      - Floor Plans
      description: Requires `floorplan_regions:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FloorplanRegionCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FloorplanRegion'
        '400':
          $ref: '#/components/responses/BadRequest'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /floorplan-regions/{id}:
    get:
      operationId: getFloorplanRegion
      summary: Get floorplan region by ID
      tags:
      - Floor Plans
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Region detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FloorplanRegion'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateFloorplanRegion
      summary: Update floorplan region
      tags:
      - Floor Plans
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FloorplanRegionUpdate'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FloorplanRegion'
    delete:
      operationId: deleteFloorplanRegion
      summary: Delete floorplan region
      tags:
      - Floor Plans
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /asset-placements:
    get:
      operationId: listAssetPlacements
      summary: List asset placements
      tags:
      - Floor Plans
      description: Asset pin locations on floorplans (one per asset globally). Requires `asset_placements:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - name: asset_id
        in: query
        schema:
          type: string
          format: uuid
      - name: floorplan_id
        in: query
        schema:
          type: string
          format: uuid
      - name: region_id
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Paginated placement list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AssetPlacement'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
    post:
      operationId: createAssetPlacement
      summary: Place asset on floorplan (upsert by asset_id)
      tags:
      - Floor Plans
      description: Places an asset at a given (x, y) on a floorplan. UPSERTS by asset_id — calling with an existing asset_id moves the pin instead of creating a duplicate. Use `bulk_create` with `resource=asset-placements` for batch placement. Requires `asset_placements:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetPlacementCreate'
      responses:
        '201':
          description: Created or updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AssetPlacement'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /asset-placements/{id}:
    get:
      operationId: getAssetPlacement
      summary: Get asset placement by ID
      tags:
      - Floor Plans
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Placement detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AssetPlacement'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateAssetPlacement
      summary: Update asset placement
      tags:
      - Floor Plans
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetPlacementUpdate'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AssetPlacement'
    delete:
      operationId: deleteAssetPlacement
      summary: Delete asset placement
      tags:
      - Floor Plans
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Deleted:
      description: Resource deleted
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              message:
                type: string
    RateLimited:
      description: Rate limit exceeded
      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'
  schemas:
    AssetPlacementCreate:
      type: object
      required:
      - asset_id
      - floorplan_id
      - x
      - y
      properties:
        asset_id:
          type: string
          format: uuid
        floorplan_id:
          type: string
          format: uuid
        x:
          type: number
          minimum: 0
          maximum: 1
        y:
          type: number
          minimum: 0
          maximum: 1
        region_id:
          type: string
          format: uuid
          nullable: true
        source:
          type: string
          enum:
          - manual
          - ai
    FloorplanUpdate:
      type: object
      properties:
        floor_label:
          type: string
          maxLength: 200
        floor_order:
          type: integer
          minimum: 0
        status:
          type: string
          enum:
          - pending
          - detecting
          - ready
          - failed
        detection_error:
          type: string
          maxLength: 2000
          nullable: true
    FloorplanRegionUpdate:
      type: object
      properties:
        label:
          type: string
          maxLength: 500
        polygon:
          $ref: '#/components/schemas/FloorplanPolygon'
        location_id:
          type: string
          format: uuid
          nullable: true
        confidence:
          type: number
          minimum: 0
          maximum: 1
        reviewed:
          type: boolean
    Error:
      type: object
      properties:
        error:
          type: string
          example: Asset not found
    FloorplanRegion:
      type: object
      description: A labeled room or zone on a floorplan, optionally linked to a Location.
      properties:
        id:
          type: string
          format: uuid
        tenant_id:
          type: string
        floorplan_id:
          type: string
          format: uuid
        location_id:
          type: string
          format: uuid
          nullable: true
        label:
          type: string
        polygon:
          $ref: '#/components/schemas/FloorplanPolygon'
        bbox:
          type: object
          nullable: true
          description: Axis-aligned bounding box in normalized 0-1 coords
          properties:
            x:
              type: number
            y:
              type: number
            w:
              type: number
            h:
              type: number
        source:
          type: string
          enum:
          - manual
          - ai
        confidence:
          type: number
          minimum: 0
          maximum: 1
          nullable: true
        reviewed:
          type: boolean
        created_by:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Floorplan:
      type: object
      description: 'One floor (or sheet) sourced from one page of an uploaded PDF. Each floorplan

        belongs to **exactly one** of `building_id` (per-building floor) or `site_id`

        (site-level / campus plan).

        '
      properties:
        id:
          type: string
          format: uuid
        tenant_id:
          type: string
        building_id:
          type: string
          format: uuid
          nullable: true
          description: Set for building-scoped floorplans; null for site-scoped
        site_id:
          type: string
          format: uuid
          nullable: true
          description: Set for site-scoped floorplans (campus / outdoor); null for building-scoped
        floor_label:
          type: string
        floor_order:
          type: integer
        pdf_storage_path:
          type: string
          description: Supabase Storage path to the PDF
        pdf_filename:
          type: string
        page_number:
          type: integer
          description: 1-indexed page within the PDF
        page_width_pt:
          type: number
          nullable: true
        page_height_pt:
          type: number
          nullable: true
        rotation_deg:
          type: integer
          enum:
          - 0
          - 90
          - 180
          - 270
          description: Display rotation, clockwise
        status:
          type: string
          enum:
          - pending
          - detecting
          - ready
          - failed
        detection_error:
          type: string
          nullable: true
        uploaded_by:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    AssetPlacement:
      type: object
      description: A single asset pin on a floorplan. Unique per asset_id (one placement per asset globally).
      properties:
        id:
          type: string
          format: uuid
        tenant_id:
          type: string
        asset_id:
          type: string
          format: uuid
        floorplan_id:
          type: string
          format: uuid
        region_id:
          type: string
          format: uuid
          nullable: true
        x:
          type: number
          minimum: 0
          maximum: 1
          description: Normalized x (0=left, 1=right)
        y:
          type: number
          minimum: 0
          maximum: 1
          description: Normalized y (0=top, 1=bottom)
        source:
          type: string
          enum:
          - manual
          - ai
        placed_by:
          type: string
          nullable: true
        placed_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    FloorplanPolygon:
      type: array
      description: Polygon outline as an array of [x, y] points in normalized 0-1 coordinates (origin top-left). At least 3 points.
      minItems: 3
      items:
        type: array
        minItems: 2
        maxItems: 2
        items:
          type: number
          minimum: 0
          maximum: 1
    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
    AssetPlacementUpdate:
      type: object
      properties:
        x:
          type: number
          minimum: 0
          maximum: 1
        y:
          type: number
          minimum: 0
          maximum: 1
        region_id:
          type: string
          format: uuid
          nullable: true
        floorplan_id:
          type: string
          format: uuid
    FloorplanCreate:
      type: object
      required:
      - floor_label
      - pdf_storage_path
      - pdf_filename
      description: 'Provide **exactly one** of `building_id` or `site_id`. Returns 400 if both

        or neither are supplied.

        '
      properties:
        building_id:
          type: string
          format: uuid
          description: Building this floor belongs to (omit for site-scoped)
        site_id:
          type: string
          format: uuid
          description: Site this plan belongs to (use for campus / outdoor plans; omit for building-scoped)
        floor_label:
          type: string
          maxLength: 200
        floor_order:
          type: integer
          minimum: 0
        pdf_storage_path:
          type: string
          maxLength: 1000
        pdf_filename:
          type: string
          maxLength: 500
        page_number:
          type: integer
          minimum: 1
        page_width_pt:
          type: number
          minimum: 0
        page_height_pt:
          type: number
          minimum: 0
        status:
          type: string
          enum:
          - pending
          - detecting
          - ready
          - failed
    FloorplanRegionCreate:
      type: object
      required:
      - floorplan_id
      - label
      - polygon
      properties:
        floorplan_id:
          type: string
          format: uuid
        label:
          type: string
          maxLength: 500
        polygon:
          $ref: '#/components/schemas/FloorplanPolygon'
        location_id:
          type: string
          format: uuid
          nullable: true
        source:
          type: string
          enum:
          - manual
          - ai
        confidence:
          type: number
          minimum: 0
          maximum: 1
        reviewed:
          type: boolean
  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