overview.md

The FOLIO Reporting API provides simple mediated access to a reporting database (LDP Classic or MetaDB) hosted elsewhere. It provides only five entry points, each of them very simple:

1. /ldp/db/tables: Request a list of all the tables in their various schemas
2. /ldp/db/columns: Request a list of all the columns in a specified table. (The schema and table names are povided as URL query parameters)
3. /ldp/db/query: Submit a query
4. /ldp/db/reports: Run a report from a repository
5. /ldp/config and /ldp/config/{key}: Simple key/value configuration store

Several types are defined to support these operations:

• The first operation returns tables, a list of table-and-schema-name pairs.
• The second operation returns columns, a list of column definitions including information such as the column name and type.
• The third operation accepts a query, a set of parameters such as the table to search in, the criteria, and the columns to return. It returns results, a list of objects representing rows that satisfy the query, each containing the specified set of columns.
• The fourth operation accepts a template query, specifying where to find the report and what values to substituted into its parameters. It returns template results, a list of result objects together with a result count.
• The fifth operation deals with config objects and lists thereof