US-EPA-CAMD / easey-ui

Project Management repo for EPA Clean Air Markets Division (CAMD) Business Suite of applications
MIT License
0 stars 0 forks source link

Monitoring Plan API Audit Implementation #6462

Open maheese opened 1 week ago

maheese commented 1 week ago

Based on the solution that was created in #4732, finish implementation of the audit records for the monitoring plan API. The implementation focuses only on the workspace methods. The events include operations that create, update, delete or retrieve records. The audits should contain the standard meta data identified in #4732 and the following items for each endpoint.

Plans

GET /monitor-plan-mgmt/workspace/plans/export eventName:"Exported monitoring plan" moreInfo planId

GET /monitor-plan-mgmt/workspace/plans/{planId} eventName:"Retrieved monitoring plan" moreInfo planId

POST /monitor-plan-mgmt/workspace/plans/import eventName:"Imported monitoring plan" moreInfo orisCode unitId(s) stackPipeId(s)

POST /monitor-plan-mgmt/workspace/plans/single-unit eventName:"Created single unit plan" moreInfo: orisCode unitId

DELETE /monitor-plan-mgmt/workspace/plans/{planId}/revert Completed in #4372

Comments

GET /monitor-plan-mgmt/workspace/plans/{planId}/comments eventName:"Retrieved workspace comments" moreInfo: planId

Locations

GET /monitor-plan-mgmt/workspace/locations/{locId} eventName:"Retrieved workspace location data" moreInfo: locId unitId stackPipeId

GET /monitor-plan-mgmt/workspace/locations/{locId}/relationships eventName:"Retrieved workspace relationship data" moreInfo: locId

Attributes

GET /monitor-plan-mgmt/workspace/locations/{locId}/attributes eventName:"Retrieved workspace monitor location attribute records" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/attributes eventName:"Created workspace monitor location attribute record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/attributes/{attributeId} eventName:"Updated workspace monitor location attribute record" moreInfo: locId \<record>

Unit Capacities

GET /monitor-plan-mgmt/workspace/locations/{locId}/units/{unitId}/unit-capacities eventName:"Retrieved workspace monitor location unit capacity records" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/units/{unitId}/unit-capacities eventName:"Create workspace monitor location unit capacity record" moreInfo: locId unitId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/units/{unitId}/unit-capacities/{unitCapacityId} eventName:"Update workspace monitor location unit capacity record" moreInfo: locId unitId \<record>

Unit Controls

GET /monitor-plan-mgmt/workspace/locations/{locId}/unit-controls eventName:"Retrieved workspace monitor location unit controls" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/unit-controls eventName:"Created workspace monitor location unit control record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/unit-controls/{unitControlId} eventName:"Updated workspace monitor location unit control record" moreInfo: locId unitControlId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/unit-controls/{unitControlId} eventName:"Deleted workspace monitor location unit control record" moreInfo: locId unitControlId

Unit Fuels

GET /monitor-plan-mgmt/workspace/locations/{locId}/unit-fuels eventName:"Retrieved workspace monitor location unit fuels" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/unit-fuels eventName:"Created workspace monitor location unit fuel record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/unit-fuels/{unitFuelId} eventName:"Updated workspace monitor location unit fuel record" moreInfo: locId unitFuelId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/unit-fuels/{unitFuelId} eventName:"Deleted workspace monitor location unit fuel record" moreInfo: locId unitFuelId

Methods

GET /monitor-plan-mgmt/workspace/locations/{locId}/methods eventName:"Retrieved workspace monitor location methods" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/methods eventName:"Created workspace monitor location method record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/methods/{methodId} eventName:"Updated workspace monitor location method record" moreInfo: locId methodId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/methods/{methodId} eventName:"Deleted workspace monitor location method record" moreInfo: locId methodId

MATS Methods

GET /monitor-plan-mgmt/workspace/locations/{locId}/mats-methods eventName:"Retrieved workspace monitor location MATS methods" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/mats-methods eventName:"Created workspace monitor location MATS method record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/mats-methods/{matsMethodId} eventName:"Updated workspace monitor location MATS method record" moreInfo: locId matsMethodId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/mats-methods/{matsMethodId} eventName:"Deleted workspace monitor location MATS method record" moreInfo: locId matsMethodId

Formulas

GET /monitor-plan-mgmt/workspace/locations/{locId}/formulas eventName:"Retrieved workspace monitor location formulas" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/formulas eventName:"Created workspace monitor location formula record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/formulas/{formulaId} eventName:"Updated workspace monitor location formula record" moreInfo: locId formulaId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/formulas/{formulaId} eventName:"Deleted workspace monitor location formula record" moreInfo: locId formulaId

Defaults

GET /monitor-plan-mgmt/workspace/locations/{locId}/defaults eventName:"Retrieved workspace monitor location default records" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/defaults eventName:"Created workspace monitor location default record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/defaults/{defaultId} eventName:"Updated workspace monitor location default record" moreInfo: locId defaultId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/defaults/{defaultId} eventName:"Deleted workspace monitor location default record" moreInfo: locId defaultId

Spans

GET /monitor-plan-mgmt/locations/{locId}/spans

GET /monitor-plan-mgmt/workspace/locations/{locId}/spans eventName:"Retrieved workspace monitor location spans" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/spans eventName:"Created workspace monitor location span record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/spans/{spanId} eventName:"Updated workspace monitor location span record" moreInfo: locId spanId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/spans/{spanId} eventName:"Deleted workspace monitor location span record" moreInfo: locId spanId

Rectangular Duct WAF

GET /monitor-plan-mgmt/workspace/locations/{locId}/duct-wafs eventName:"Retrieved workspace monitor location duct waf records" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/duct-wafs eventName:"Created workspace monitor location duct waf record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/duct-wafs/{ductWafId} eventName:"Updated workspace monitor location duct waf record" moreInfo: locId ductWafId \<record>

Rectangular Duct WAFs

GET /monitor-plan-mgmt/workspace/locations/{locId}/rectangular-duct-wafs eventName:"Retrieved workspace monitor location rectangular duct WAFs" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/rectangular-duct-wafs eventName:"Created workspace monitor location rectangular duct WAF record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/rectangular-duct-wafs/{wafId} eventName:"Updated workspace monitor location rectangular duct WAF record" moreInfo: locId wafId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/rectangular-duct-wafs/{wafId} eventName:"Deleted workspace monitor location rectangular duct WAF record" moreInfo: locId wafId

Loads

GET /monitor-plan-mgmt/workspace/locations/{locId}/loads eventName:"Retrieved workspace monitor location loads" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/loads eventName:"Created workspace monitor location load record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/loads/{loadId} eventName:"Updated workspace monitor location load record" moreInfo: locId loadId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/loads/{loadId} eventName:"Deleted workspace monitor location load record" moreInfo: locId loadId

Components

GET /monitor-plan-mgmt/workspace/locations/{locId}/components eventName:"Retrieved workspace monitor location components" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/components eventName:"Created workspace monitor location component record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/components/{componentId} eventName:"Updated workspace monitor location component record" moreInfo: locId componentId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/components/{componentId} eventName:"Deleted workspace monitor location component record" moreInfo: locId componentId

Analyzer Ranges

GET /monitor-plan-mgmt/workspace/locations/{locId}/components/{compId}/analyzer-ranges eventName:"Retrieved workspace monitor location component analyzer range records" moreInfo: locId compId

POST /monitor-plan-mgmt/workspace/locations/{locId}/components/{compId}/analyzer-ranges eventName:"Created workspace monitor location component analyzer range record" moreInfo: locId compId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/components/{compId}/analyzer-ranges/{analyzerRangeId} eventName:"Updated workspace monitor location component analyzer range record" moreInfo: locId compId analyzerRangeId \<record>

Systems

GET /monitor-plan-mgmt/workspace/locations/{locId}/systems eventName:"Retrieved workspace monitor location systems" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/systems eventName:"Created workspace monitor location system record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/systems/{systemId} eventName:"Updated workspace monitor location system record" moreInfo: locId systemId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/systems/{systemId} eventName:"Deleted workspace monitor location system record" moreInfo: locId systemId

System Fuel Flows

GET /monitor-plan-mgmt/workspace/locations/{locId}/systems/{sysId}/fuel-flows eventName:"Retrieved workspace monitor location system fuel flow records" moreInfo: locId sysId

POST /monitor-plan-mgmt/workspace/locations/{locId}/systems/{sysId}/fuel-flows eventName:"Created workspace monitor location system fuel flow record" moreInfo: locId sysId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/systems/{sysId}/fuel-flows/{fuelFlowId} eventName:"Updated workspace monitor location system fuel flow record" moreInfo: locId sysId fuelFlowId \<record>

System Components

GET /monitor-plan-mgmt/workspace/locations/{locId}/systems/{sysId}/components eventName:"Retrieved workspace monitor location system components" moreInfo: locId sysId

POST /monitor-plan-mgmt/workspace/locations/{locId}/systems/{sysId}/components eventName:"Created workspace monitor location system component record" moreInfo: locId sysId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/systems/{sysId}/components/{monSysCompId} eventName:"Updated workspace monitor location system component record" moreInfo: locId sysId monSysCompId \<record>

Qualifications

GET /monitor-plan-mgmt/workspace/locations/{locId}/qualifications eventName:"Retrieved workspace monitor location qualifications" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/qualifications eventName:"Created workspace monitor location qualification record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualificationId} eventName:"Updated workspace monitor location qualification record" moreInfo: locId qualificationId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualificationId} eventName:"Deleted workspace monitor location qualification record" moreInfo: locId qualificationId

LEE Qualifications

GET /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualId}/lee-qualifications eventName:"Retrieved workspace monitor location LEE qualifications" moreInfo: locId qualId

POST /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualId}/lee-qualifications eventName:"Created workspace monitor location LEE qualification record" moreInfo: locId qualId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualId}/lee-qualifications/{leeQualId} eventName:"Updated workspace monitor location LEE qualification record" moreInfo: locId qualId leeQualId \<record>

LME Qualifications

GET /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualId}/lme-qualifications eventName:"Retrieved workspace monitor location LME qualifications" moreInfo: locId qualId

POST /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualId}/lme-qualifications eventName:"Created workspace monitor location LME qualification record" moreInfo: locId qualId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualId}/lme-qualifications/{lmeQualId} eventName:"Updated workspace monitor location LME qualification record" moreInfo: locId qualId lmeQualId \<record>

PCT Qualifications

GET /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualId}/pct-qualifications eventName:"Retrieved workspace monitor location PCT qualifications" moreInfo: locId qualId

POST /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualId}/pct-qualifications eventName:"Created workspace monitor location PCT qualification record" moreInfo: locId qualId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/qualifications/{qualId}/pct-qualifications/{pctQualId} eventName:"Updated workspace monitor location PCT qualification record" moreInfo: locId qualId pctQualId \<record>

Reporting Frequencies

GET /monitor-plan-mgmt/workspace/locations/{locId}/units/{unitId}/reporting-frequencies eventName:"Retrieved workspace monitor location unit reporting frequencies"

Configurations

GET /monitor-plan-mgmt/workspace/configurations eventName:"Retrieved workspace configurations" moreInfo: orisCodes monPlanIds

Stacks & Pipes

POST /monitor-plan-mgmt/workspace/stack-pipes/import eventName:"Imported workspace stack pipes" moreInfo: \<record>

Unit Programs

GET /monitor-plan-mgmt/workspace/locations/{locId}/units/{unitId}/unit-programs eventName:"Retrieved workspace monitor location unit programs" moreInfo: locId unitId

GET /monitor-plan-mgmt/locations/{locId}/units/{unitId}/unit-programs

Units

GET /monitor-plan-mgmt/workspace/locations/{locId}/units/{id} eventName:"Retrieved workspace monitor location unit" moreInfo: locId id

PUT /monitor-plan-mgmt/workspace/locations/{locId}/units/{id} eventName:"Updated workspace monitor location unit" moreInfo: locId id \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/units/{id} eventName:"Deleted workspace monitor location unit" moreInfo: locId id

Unit Fuel Flows

GET /monitor-plan-mgmt/workspace/locations/{locId}/unit-fuel-flows eventName:"Retrieved workspace monitor location unit fuel flows" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/unit-fuel-flows eventName:"Created workspace monitor location unit fuel flow record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/unit-fuel-flows/{unitFuelFlowId} eventName:"Updated workspace monitor location unit fuel flow record" moreInfo: locId unitFuelFlowId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/unit-fuel-flows/{unitFuelFlowId} eventName:"Deleted workspace monitor location unit fuel flow record" moreInfo: locId unitFuelFlowId

Unit Operating Times

GET /monitor-plan-mgmt/workspace/locations/{locId}/unit-operating-times eventName:"Retrieved workspace monitor location unit operating times" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/unit-operating-times eventName:"Created workspace monitor location unit operating time record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/unit-operating-times/{unitOperatingTimeId} eventName:"Updated workspace monitor location unit operating time record" moreInfo: locId unitOperatingTimeId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/unit-operating-times/{unitOperatingTimeId} eventName:"Deleted workspace monitor location unit operating time record" moreInfo: locId unitOperatingTimeId

Unit Capacities

GET /monitor-plan-mgmt/workspace/locations/{locId}/unit-capacities eventName:"Retrieved workspace monitor location unit capacities" moreInfo: locId

POST /monitor-plan-mgmt/workspace/locations/{locId}/unit-capacities eventName:"Created workspace monitor location unit capacity record" moreInfo: locId \<record>

PUT /monitor-plan-mgmt/workspace/locations/{locId}/unit-capacities/{unitCapacityId} eventName:"Updated workspace monitor location unit capacity record" moreInfo: locId unitCapacityId \<record>

DELETE /monitor-plan-mgmt/workspace/locations/{locId}/unit-capacities/{unitCapacityId} eventName:"Deleted workspace monitor location unit capacity record" moreInfo: locId unitCapacityId

Check-Outs

GET /monitor-plan-mgmt/workspace/check-outs/plans eventName:"Retrieved workspace check-out plans" moreInfo: none

POST /monitor-plan-mgmt/workspace/check-outs/plans/{planId} eventName:"Checked out workspace plan" moreInfo: planId \<record>

PUT /monitor-plan-mgmt/workspace/check-outs/plans/{planId} eventName:"Updated workspace last activity for a checked out plan" moreInfo: planId \<record>

DELETE /monitor-plan-mgmt/workspace/check-outs/plans/{planId} eventName:"Checked in workspace plan" moreInfo: planId