The API differs from the web interface in that, rather than listing cases in one action and viewing specific cases in another, you can return both a list of cases and the exact information you want about them at the same time using the
To list cases, send
cmd=search. For example:
You can use one of the following arguments:
The query term you are searching for can be a string, a case number, or a comma-separated list of case numbers without spaces, e.g. 12,25,556.Note: To search for the number 123 and not the case 123, enclose your search in quotes ("123"). This search acts exactly the same way the search box in FogBugz operates, so you can use that to debug.
qis not present, it returns the cases in your current filter.
If the current filter matches a saved or built-in filter, the
sFilteris also returned.
This argument specifies the information you would like to be returned, with each case in the list.
The parameter should be a comma-separated list of column names:
The available columns are listed in the use case XML output.
Additional columns: If you include
events, you will also receive all the events for that case. Include
latestEventto get only the latest event. For Custom Fields and other plugin fields, see Access Custom Fields and Other Plugin Data with the XML API.
ixcolumns can be
0if they are not set.
ixPersonClosedBy, for example) will be
> 0if there is a valid person who closed this case.
- This argument specifies the maximum number of bugs you want to be returned.
- If you want all the bugs, leave this off.
Also refer to the full XML API documentation.