The Basics


cmd=listFilters

Parameters
  None.
Example
  https://kakapo.fogbugz.com/api.asp?cmd=listFilters&token=9o2atgqi41642331c5f6lo5c37u1ec
Returns
  A list of filters, including filter name and type (built-in, saved, or shared).

cmd=setCurrentFilter

Parameters
  Takes sFilter, the id of the filter you'd like to set as current.
Example
  https://kakapo.fogbugz.com/api.asp?cmd=setCurrentFilter&sFilter=402&token=9o2atgqi41642331c5f6lo5c37u1ec
Returns
  Empty response.

Listing Filters (cmd=listFilters)

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=listFilters&token=9o2atgqi41642331c5f6lo5c37u1ec
fogbugz.py
S_FOGBUGZ_URL   = 'https://kakapo.fogbugz.com/'
TOKEN      = '9o2atgqi41642331c5f6lo5c37u1ec'

fb = FogBugz(S_FOGBUGZ_URL, TOKEN)
resp = fb.listFilters()
print resp


Response

XML
<response>
  <filters>
    <filter type="builtin" sFilter="ez349">My Cases</filter>
    <filter type="saved" sFilter="304">Cases I should have closed months ago</filter>
    <filter type="shared" sFilter="98" status="current">Customer Service Top 10</filter>
  </filters>
</response>

Setting the Current Filter (cmd=setCurrentFilter)

To change the current filter (pass in the sFilter attribute from the listFilters cmd).

Parameters

  • sFilter
    • The sFilter value to set (given by the listFilters command)

Example

URL
https://kakapo.fogbugz.com/api.asp?cmd=listFilters&token=9o2atgqi41642331c5f6lo5c37u1ec
fogbugz.py
S_FOGBUGZ_URL   = 'https://kakapo.fogbugz.com/'
TOKEN      = '9o2atgqi41642331c5f6lo5c37u1ec'

fb = FogBugz(S_FOGBUGZ_URL, TOKEN)
resp = fb.listFilters()
print resp

Passing a filter cmd=listCases is a preferable alternative to resetting the current filter via the API if your goal is to use one of your filters to search cases in the API.


Response

The response is purposefully empty.

XML
<response></response>