Skip to content

Update search to paginate and handle new max parameter #11

@craig-davis

Description

@craig-davis

From FogBugz:

We have an update coming soon to the FogBugz XML API which changes a default behavior. We have not designated this as a breaking change because we designed it not to impact any accounts with normal usage. (i.e. the major version and minversion reported by api.xml will not change) It is important, however, for makers of applications and libraries to verify that case searches and filters are not requesting too many cases back from FogBugz.

Currently, if you do not specify a 'max' parameter when you use the 'search' or 'listCases' commands, FogBugz returns all matching results. In practice, we find that requests often time out for more than around 10,000 cases so there is a de facto limit which depends on the query. When we roll this change out to FogBugz On Demand accounts, the default behavior when no 'max' parameter is given or max is set to 0 will be to limit the results to 50,000 cases. In our testing, asking for more than 100,000 cases causes undue load on our servers and can negatively impact other accounts, so we now return an error (code 30) for anything more than 'max=100000'.

Please take a look at your code and, if possible, ensure that it is setting a value for the 'max' parameter. If the user is able to set a max, make sure your code passes the error code 30 along to them if they ask for more than 100,000 results.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions