Reports - digitalspace/eagle-demi GitHub Wiki
Reports
Two CSV reads replace eagle-api's comment export and BCGW report. Both have handlers in
eagle-demi. Rows and fields follow DEMI's access rules, see Attribute-Level-Access.
| Route | Caller | Replaces in eagle-api |
|---|---|---|
GET /commentperiods/:periodId/comments/export |
signed in | GET /api/comment/export/{periodId} |
GET /reports?type=bcgw |
public | GET /api/reports?type=bcgw |
Comment export
The caller's level picks the format. A level 2 caller (sysadmin, staff) gets the staff format. Any
other caller gets the proponent format, and only published comments. In both formats Author
reads Anonymous on an anonymous comment.
Rows are the comments the caller can read. Each row passes through the field redactor first, so a
hidden field is an empty cell. Attachment links point at /documents/:id/download on the host the
caller used, and list only documents the caller can read. Text that starts with =, +, - or
@ gets a leading ' so a spreadsheet does not run it as a formula. Pillar is always empty,
because DEMI does not copy that field.
BCGW report
The feed of published projects for the BC Geographic Warehouse. It always reads as an anonymous
caller, so a signed-in caller gets the same file. Columns and values match eagle-api's file,
including the Project GUID cell wrapped in quotes.
Both responses are built whole, because the Functions host sends one buffered body.