CAM — Monitoring Plan Management

{
  "openapi": "3.0.0",
  "paths": {
    "/monitor-plan-mgmt/health": {
      "get": {
        "operationId": "HealthController_check",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The Health Check is successful",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "info": {
                      "type": "object",
                      "example": {
                        "database": {
                          "status": "up"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      "nullable": true
                    },
                    "error": {
                      "type": "object",
                      "example": {},
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      "nullable": true
                    },
                    "details": {
                      "type": "object",
                      "example": {
                        "database": {
                          "status": "up"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  }
                },
                "examples": {
                  "HealthController_check200Example": {
                    "summary": "Default HealthController_check 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "The Health Check is not successful",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "info": {
                      "type": "object",
                      "example": {
                        "database": {
                          "status": "up"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      "nullable": true
                    },
                    "error": {
                      "type": "object",
                      "example": {
                        "redis": {
                          "status": "down",
                          "message": "Could not connect"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      "nullable": true
                    },
                    "details": {
                      "type": "object",
                      "example": {
                        "database": {
                          "status": "up"
                        },
                        "redis": {
                          "status": "down",
                          "message": "Could not connect"
                        }
                      },
                      "additionalProperties": {
                        "type": "object",
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  }
                },
                "examples": {
                  "HealthController_check503Example": {
                    "summary": "Default HealthController_check 503 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Health"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/plans/export": {
      "get": {
        "operationId": "MonitorPlanController_exportMonitorPlan",
        "parameters": [
          {
            "name": "planId",
            "required": true,
            "in": "query",
            "description": "The Monintor Plan Summary ID is a unique identifier for a monitor plan record",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          },
          {
            "name": "reportedValuesOnly",
            "required": false,
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "example": true
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official Monitor Plan record",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MonitorPlanDTO"
                },
                "examples": {
                  "MonitorPlanController_exportMonitorPlan200Example": {
                    "summary": "Default MonitorPlanController_exportMonitorPlan 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Plans"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/plans/{planId}": {
      "get": {
        "operationId": "MonitorPlanController_getMonitorPlan",
        "parameters": [
          {
            "name": "planId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves information needed to refresh a monitor plan",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MonitorPlanDTO"
                },
                "examples": {
                  "MonitorPlanController_getMonitorPlan200Example": {
                    "summary": "Default MonitorPlanController_getMonitorPlan 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Plans"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/plans/{planId}/comments": {
      "get": {
        "operationId": "MonitorPlanCommentController_getComments",
        "parameters": [
          {
            "name": "planId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official comment records for a monitor plan",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/MonitorPlanCommentDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "MonitorPlanCommentController_getComments200Example": {
                    "summary": "Default MonitorPlanCommentController_getComments 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Comments"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}": {
      "get": {
        "operationId": "MonitorLocationController_getLocation",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official location record from a specific location ID",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MonitorLocationDTO"
                },
                "examples": {
                  "MonitorLocationController_getLocation200Example": {
                    "summary": "Default MonitorLocationController_getLocation 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Locations"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/relationships": {
      "get": {
        "operationId": "MonitorLocationController_getLocationRelationships",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official relationships record for a specific location ID",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/UnitStackConfigurationDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "MonitorLocationController_getLocationRelationships200Example": {
                    "summary": "Default MonitorLocationController_getLocationRelationships 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Locations"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/attributes": {
      "get": {
        "operationId": "MonitorAttributeController_getAttributes",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official attribute records for a monitor location",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/MonitorAttributeDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "MonitorAttributeController_getAttributes200Example": {
                    "summary": "Default MonitorAttributeController_getAttributes 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Attributes"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/units/{unitId}/unit-capacities": {
      "get": {
        "operationId": "UnitCapacityController_getUnitCapacities",
        "parameters": [
          {
            "name": "unitId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            },
            "example": 0.0
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves workspace unit capacity records from a specific unit ID",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/UnitCapacityDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "UnitCapacityController_getUnitCapacities200Example": {
                    "summary": "Default UnitCapacityController_getUnitCapacities 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Unit Capacities"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/units/{unitId}/unit-controls": {
      "get": {
        "operationId": "UnitControlController_getUnitControls",
        "parameters": [
          {
            "name": "unitId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            },
            "example": 0.0
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves workspace unit control records from a specific unit ID",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/UnitControlDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "UnitControlController_getUnitControls200Example": {
                    "summary": "Default UnitControlController_getUnitControls 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Unit Controls"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/units/{unitId}/unit-fuels": {
      "get": {
        "operationId": "UnitFuelController_getUnitFuels",
        "parameters": [
          {
            "name": "unitId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "number"
            },
            "example": 0.0
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official unit fuel records from a specific unit ID",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/UnitFuelDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "UnitFuelController_getUnitFuels200Example": {
                    "summary": "Default UnitFuelController_getUnitFuels 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Unit Fuels"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/methods": {
      "get": {
        "operationId": "MonitorMethodController_getMethods",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official method records for a monitor location",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/MonitorMethodDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "MonitorMethodController_getMethods200Example": {
                    "summary": "Default MonitorMethodController_getMethods 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Methods"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/mats-methods": {
      "get": {
        "operationId": "MatsMethodController_getMethods",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official MATS Method records for a monitor location",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/MatsMethodDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "MatsMethodController_getMethods200Example": {
                    "summary": "Default MatsMethodController_getMethods 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "MATS Methods"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/formulas": {
      "get": {
        "operationId": "MonitorFormulaController_getFormulas",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official formula records for a monitor location",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/MonitorFormulaDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "MonitorFormulaController_getFormulas200Example": {
                    "summary": "Default MonitorFormulaController_getFormulas 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Formulas"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/defaults": {
      "get": {
        "operationId": "MonitorDefaultController_getDefaults",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official default records for a monitor location",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/MonitorDefaultDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "MonitorDefaultController_getDefaults200Example": {
                    "summary": "Default MonitorDefaultController_getDefaults 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Defaults"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/spans": {
      "get": {
        "operationId": "MonitorSpanController_getSpans",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official span records for a monitor location",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/MonitorSpanDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "MonitorSpanController_getSpans200Example": {
                    "summary": "Default MonitorSpanController_getSpans 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Spans"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/duct-wafs": {
      "get": {
        "operationId": "DuctWafController_getDuctWafs",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official duct waf records for a monitor location",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/DuctWafDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "DuctWafController_getDuctWafs200Example": {
                    "summary": "Default DuctWafController_getDuctWafs 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Rectangular Duct WAF"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/loads": {
      "get": {
        "operationId": "MonitorLoadController_getLoads",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            },
            "example": "12345"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieves official load records for a monitor location",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/MonitorLoadDTO"
                      }
                    }
                  }
                },
                "examples": {
                  "MonitorLoadController_getLoads200Example": {
                    "summary": "Default MonitorLoadController_getLoads 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Loads"
        ],
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/monitor-plan-mgmt/locations/{locId}/components": {
      "get": {
        "operationId": "ComponentController_getComponents",
        "parameters": [
          {
            "name": "locId",
            "required": true,
            "in": "path",
        

# --- truncated at 32 KB (228 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/epa/refs/heads/main/openapi/cam-monitor-plan-openapi.json