{ "openapi": "3.0.0", "paths": { "/camd-services/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" } } }, "/camd-services/bulk-files": { "get": { "description": "Retrieves a list of bulk data files and their metadata from S3.", "operationId": "BulkFileController_getBulkFiles", "parameters": [], "responses": { "200": { "description": "Data retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BulkFileDTO" } } } }, "examples": { "BulkFileController_getBulkFiles200Example": { "summary": "Default BulkFileController_getBulkFiles 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } } }, "security": [ { "APIKey": [] } ], "summary": "", "tags": [ "Bulk Files" ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/camd-services/reports/list": { "get": { "description": "Retrieves list of official reports available.", "operationId": "ReportController_getAvailableReports", "parameters": [], "responses": { "200": { "description": "Data retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDTO" }, "examples": { "ReportController_getAvailableReports200Example": { "summary": "Default ReportController_getAvailableReports 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } } }, "security": [ { "APIKey": [] } ], "summary": "", "tags": [ "Reports" ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/camd-services/reports": { "get": { "description": "Retrieves official data for various reports based on criteria.", "operationId": "ReportController_getReport", "parameters": [ { "name": "reportCode", "required": true, "in": "query", "schema": { "type": "string" }, "example": "string" }, { "name": "facilityId", "required": true, "in": "query", "schema": { "type": "number" }, "example": 0.0 }, { "name": "monitorPlanId", "required": false, "in": "query", "schema": { "type": "string" }, "example": "12345" }, { "name": "testId", "required": false, "in": "query", "style": "pipeDelimited", "explode": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "12345" ] }, { "name": "qceId", "required": false, "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "12345" ] }, { "name": "teeId", "required": false, "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "12345" ] }, { "name": "year", "required": false, "in": "query", "schema": { "type": "number" }, "example": 2024 }, { "name": "quarter", "required": false, "in": "query", "schema": { "type": "number" }, "example": 0.0 }, { "name": "locationId", "required": false, "in": "query", "schema": { "type": "string" }, "example": "12345" }, { "name": "reportingPeriodIds", "required": false, "in": "query", "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "Data retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDTO" }, "examples": { "ReportController_getReport200Example": { "summary": "Default ReportController_getReport 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } } }, "security": [ { "APIKey": [] } ], "summary": "", "tags": [ "Reports" ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/camd-services/support/email/emailRecipientList": { "post": { "description": "Retrieves a list of email recipients based on email type and plant IDs.", "operationId": "MailController_getEmailRecipientList", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRecipientListRequestDto" }, "examples": { "MailController_getEmailRecipientListRequestExample": { "summary": "Default MailController_getEmailRecipientList request", "x-microcks-default": true, "value": {} } } } } }, "responses": { "200": { "description": "Email recipient list retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRecipientListResponseDto" }, "examples": { "MailController_getEmailRecipientList200Example": { "summary": "Default MailController_getEmailRecipientList 200 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } }, "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRecipientListResponseDto" }, "examples": { "MailController_getEmailRecipientList201Example": { "summary": "Default MailController_getEmailRecipientList 201 response", "x-microcks-default": true, "value": { "status": "ok", "message": "Example response" } } } } } }, "500": { "description": "" } }, "security": [ { "ClientToken": [] }, { "ClientId": [] }, { "APIKey": [] } ], "summary": "", "tags": [ "Support" ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "info": { "title": "CAMD Administrative & General Services OpenAPI Specification", "description": "Provides administrative & general services for CAMD applications.", "version": "v2.0.146 published: Thu Mar 26 2026", "contact": {} }, "tags": [], "servers": [ { "url": "https://api.epa.gov/easey" } ], "components": { "securitySchemes": { "APIKey": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "API Key required via \"x-api-key\" request header!" }, "Token": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http", "description": "Authorization \"bearer\" token required for data modification operations" }, "ClientToken": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http", "description": "Authorization \"bearer\" client JWT token required for api endpoints" }, "ClientId": { "type": "apiKey", "in": "header", "name": "x-client-id", "description": "ClientId required via \"x-client-id\" request header" } }, "schemas": { "BulkFileDTO": { "type": "object", "properties": { "filename": { "type": "string", "example": "EPA Facility" }, "s3Path": { "type": "string", "example": "string" }, "bytes": { "type": "number", "example": 0.0 }, "kiloBytes": { "type": "number", "example": 0.0 }, "megaBytes": { "type": "number", "example": 0.0 }, "gigaBytes": { "type": "number", "example": 0.0 }, "lastUpdated": { "format": "date-time", "type": "string", "example": "2024-01-15T12:00:00Z" }, "metadata": { "type": "object", "example": {} } }, "required": [ "filename", "s3Path", "bytes", "kiloBytes", "megaBytes", "gigaBytes", "lastUpdated", "metadata" ] }, "ReportColumnDTO": { "type": "object", "properties": { "code": { "type": "string", "example": "string" }, "values": { "type": "array", "items": { "type": "object" }, "example": [ {} ] } }, "required": [ "code", "values" ] }, "ReportDetailDTO": { "type": "object", "properties": { "displayName": { "type": "string", "example": "EPA Facility" }, "templateCode": { "type": "string", "example": "string" }, "templateType": { "type": "string", "example": "string" }, "results": { "type": "array", "items": { "type": "object" }, "example": [ {} ] } }, "required": [ "displayName", "templateCode", "templateType", "results" ] }, "ReportDTO": { "type": "object", "properties": { "displayName": { "type": "string", "example": "EPA Facility" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/ReportColumnDTO" }, "example": [ "string" ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDetailDTO" }, "example": [ "string" ] } }, "required": [ "displayName", "columns", "details" ] }, "EmailRecipientListRequestDto": { "type": "object", "properties": { "emailType": { "type": "string", "description": "The type of email", "example": "SUBMISSIONREMINDER" }, "plantIdList": { "description": "List of plant IDs", "example": [ 1, 3, 5 ], "type": "array", "items": { "type": "number" } } }, "required": [ "emailType", "plantIdList" ] }, "EmailRecipientListResponseDto": { "type": "object", "properties": { "recipients": { "description": "List of email recipients", "items": { "type": "array", "items": { "type": "a" } }, "type": "array", "example": [ [ "string" ] ] }, "hasError": { "type": "boolean", "description": "Indicates if an error occurred", "example": false }, "errorMessage": { "type": "string", "description": "Error message if an error occurred", "example": "" } }, "required": [ "recipients", "hasError", "errorMessage" ] } } } }