Summary

In 7.17.9, we're restoring a report generation API endpoint to create CSV reports based on saved searches. There has been one PR that serves as the first iteration: #148030

This resolves a missing capability from the first iteration. In the first iteration, POST bodies could allow an additional time range filter, which is merged with any saved filters or queries stored in the saved search object:

POST /api/reporting/v1/generate/csv/saved-object/search:${savedSearchId}
{
  timerange: {
    min: '2015-09-20 10:23:36.052',
    max: '2015-09-20 10:25:55.744'
  }
}

This PR is a second iteration. It allows additional "unsaved state" to be merged with the saved object at the time of report generation.

POST /api/reporting/v1/generate/csv/saved-object/search:${savedSearchId}
 state": {
  "query": { "multi_match": { "type": "best_fields", "query": "cognac", "lenient": true } },
  "timerange": <same as before>

POST /api/reporting/v1/generate/csv/saved-object/search:${savedSearchId}
"state": {
  "query": [
    { "multi_match": { "type": "best_fields", "query": "cognac", "lenient": true } },
    { "bool": { "must_not": { "multi_match": { "type": "best_fields", "query": "Pyramidustries", "lenient": true } } } }
  ],
 timerange": <same as before>

Details

In the details of #148030, it was stated:

Does not allow "raw state" to be merged with the Search object, as in the previous code (from 7.3-7.8). Otherwise, the API is compatible with the previous code.

This PR pushes a bit back against that limitation. Now, requests to generate a report can accept a state field in the POST body. This field contains additional "unsaved state" that gets merged with the contents of the stored saved search object.

However, the entire functionality of allowing sort and docvalue_fields keys in the request, is still not restored from the functionality that was implemented in 7.3-7.8. This limitation exists to minimize the complexity of the restored endpoint.

Both of the non-restored keys are related to the sorting of documents. The sorting of documents is controlled by the saved search object only. The user can change the sort of the CSV after downloading the report, in a spreadsheet application or by programmatically working on the file.

Checklist

Delete any items that are not applicable to this PR.

• Unit or functional tests were updated or added to match the most common scenarios