AssetLab Infrastructure Zones API

openapi: 3.2.0
info:
  title: Assetlab Ca Infrastructure Zones API
  version: '1.0'
  contact:
    name: AssetLab Support
    url: https://assetlab.ca
    email: support@assetlab.ca
  license:
    name: Proprietary
  description: 'Operations tagged Infrastructure Zones 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: Infrastructure Zones
paths:
  /infrastructure-zones:
    get:
      operationId: listInfrastructureZones
      summary: List infrastructure zones
      tags:
      - Infrastructure Zones
      description: Requires `infrastructure_zones:read` scope. Boundary is returned as a GeoJSON Polygon.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - in: query
        name: network_id
        schema:
          type: string
          format: uuid
      - in: query
        name: kind
        schema:
          type: string
          enum:
          - pressure_zone
          - dma
          - sewershed
          - storm_catchment
          - maintenance_district
      responses:
        '200':
          description: Paginated zone list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/InfrastructureZone'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createInfrastructureZone
      summary: Create infrastructure zone
      tags:
      - Infrastructure Zones
      description: Requires `infrastructure_zones:write` scope. boundary is a GeoJSON Polygon (MultiPolygon rejected). (network_id, name) is unique.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InfrastructureZoneCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/InfrastructureZone'
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          $ref: '#/components/responses/Conflict'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /infrastructure-zones/{id}:
    get:
      operationId: getInfrastructureZone
      summary: Get infrastructure zone by ID
      tags:
      - Infrastructure Zones
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Zone detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/InfrastructureZone'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateInfrastructureZone
      summary: Update infrastructure zone
      tags:
      - Infrastructure Zones
      description: Requires `infrastructure_zones:write` scope.
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InfrastructureZoneUpdate'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/InfrastructureZone'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteInfrastructureZone
      summary: Delete infrastructure zone
      tags:
      - Infrastructure Zones
      description: Requires `infrastructure_zones:write` scope.
      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
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'
    Conflict:
      description: Conflict (e.g. a uniqueness constraint was violated)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    GeoJsonPolygon:
      type: object
      required:
      - type
      - coordinates
      description: 'GeoJSON Polygon in EPSG:4326. An array of linear rings; the first is the exterior ring, the rest are holes. Each ring is closed (first and last positions identical) with at least 4 positions.

        '
      properties:
        type:
          type: string
          enum:
          - Polygon
        coordinates:
          type: array
          minItems: 1
          items:
            type: array
            minItems: 4
            items:
              type: array
              minItems: 2
              maxItems: 2
              items:
                type: number
    InfrastructureZone:
      type: object
      description: An operational hydraulic boundary attached to an infrastructure network. Boundary is rendered as a GeoJSON Polygon.
      properties:
        id:
          type: string
          format: uuid
        network_id:
          type: string
          format: uuid
        kind:
          type: string
          enum:
          - pressure_zone
          - dma
          - sewershed
          - storm_catchment
          - maintenance_district
        name:
          type: string
        code:
          type: string
          nullable: true
        boundary:
          $ref: '#/components/schemas/ZoneBoundary'
        notes:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    InfrastructureZoneCreate:
      type: object
      required:
      - network_id
      - kind
      - name
      - boundary
      properties:
        network_id:
          type: string
          format: uuid
        kind:
          type: string
          enum:
          - pressure_zone
          - dma
          - sewershed
          - storm_catchment
          - maintenance_district
        name:
          type: string
          maxLength: 200
        boundary:
          $ref: '#/components/schemas/ZoneBoundary'
        code:
          type: string
          maxLength: 50
          nullable: true
        notes:
          type: string
          nullable: 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
    InfrastructureZoneUpdate:
      type: object
      properties:
        network_id:
          type: string
          format: uuid
        kind:
          type: string
          enum:
          - pressure_zone
          - dma
          - sewershed
          - storm_catchment
          - maintenance_district
        name:
          type: string
          maxLength: 200
        boundary:
          $ref: '#/components/schemas/ZoneBoundary'
        code:
          type: string
          maxLength: 50
          nullable: true
        notes:
          type: string
          nullable: true
    ZoneBoundary:
      description: 'A zone boundary. Accepts a Polygon or a MultiPolygon on write; a single Polygon is stored as a one-part MultiPolygon and reads back in that form.

        '
      oneOf:
      - $ref: '#/components/schemas/GeoJsonPolygon'
      - $ref: '#/components/schemas/GeoJsonMultiPolygon'
    Error:
      type: object
      properties:
        error:
          type: string
          example: Asset not found
    GeoJsonMultiPolygon:
      type: object
      required:
      - type
      - coordinates
      description: 'GeoJSON MultiPolygon in EPSG:4326. An array of polygons, each an array of closed linear rings. Use it for a boundary that comes in separate pieces - an area split by a rail corridor, or one containing an island.

        '
      properties:
        type:
          type: string
          enum:
          - MultiPolygon
        coordinates:
          type: array
          minItems: 1
          items:
            type: array
            minItems: 1
            items:
              type: array
              minItems: 4
              items:
                type: array
                minItems: 2
                maxItems: 2
                items:
                  type: number
  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