Can I add a filter to an existing workbook using the REST APIs?

Sherry Miller

June 14, 2021 21:47

I'd like to run a workbook and add a custom filter prior to running the workbook. Is this possible using the REST APIs?

0

Comments

1 comment

Official comment
Brian Junio

June 14, 2021 22:04
Sherry,

Good afternoon!

Our Workbook API does not provide a means of running with an ad hoc filter.

The best bet to accomplish this programmatically with the API will be to first pull down the Workbook's JSON, edit the JSON to include your custom filter, update the Workbook, and then finally execute the job.

If you were to create a filter similar to the custom filter you are looking to inject, you can harvest the format. Below is an example of filtering the "WorkbookID" column for all values greater than 400:
```
      "filterArguments": [
        {
          "column": "WorkbookID",
          "filterExpression": "GREATER",
          "value": "400",
          "type": "CONSTANT"
        }
      ]
```
Cheers,

Brian
Comment actions Permalink

Please sign in to leave a comment.