FogBugz includes a wiki for creating and maintaining documentation. The. Fog Creek Software Made in NYC and around the world. FogBugz in Two Minutes. “But I only have one minute!” No worries, there’s a .
|Published (Last):||5 September 2015|
|PDF File Size:||10.76 Mb|
|ePub File Size:||14.7 Mb|
|Price:||Free* [*Free Regsitration Required]|
For example, if the URL is http: Or if your FogBugz On Demand account is https: If this returns an HTTP error file missing you can safely assume that either FogBugz is not installed at that location, or else it is installed, but it is a version of FogBugz that does not include the API. The file looks like this:. The minversion field is used to warn you if the current version of the API is not backwards compatible.
The private tag can almost always be ignored by non-Fog Creek api clients.
Online Documentation with the FogBugz Wiki
It is used by the FogBugz server to indicate to a client that a new version of some API client software is available on the FogBugz fogbuvz. For example, the following tag might be interpreted by the FogBugz for Visual Studio Add-in to mean that version 3 is now available docunentation the server where it can be downloaded from the URL setup-msvs.
Generating tokens in the UI is the recommended approach. FogBugz itself supports several methods of logging on, however, the only method supported by the API is by providing an email address or full name, just fobgugz FogBugz sign-in and password in the logon method:.
This token will persist until you execute a logoff command. Token reuse is encouraged over issuing repeat logon commands.
FogBugz will supply you with a list of full names; you must provide the appropriate full name to log on. If, for example, you got that response, you would prompt the user with a combo box to choose if they are John Hancock or Fred Astaire.
Once logged on, you can get a list of filters available to the current user. FogBugz has three kinds of filters:. FogBugz users will probably expect to see the three types of filters grouped as they are in FogBugz itself. The list of filters is already in the same order that users are used to seeing it in the FogBugz user interface and should be preserved.
The meaning is documentatin to FogBugz. The API differs from the web fogbuugz in that, rather than listing cases in one action and viewing specific cases in another, cocumentation can return both a list of cases and the exact information you want about them all at the same time using the cols parameter.
An example of an html page which submits to the api to create a new case and upload a file would look like this:.
FogBugz Plugin API Documentation – FogBugz Knowledge Base
You can read more about this encoding type in the RFC. It is not required, but we recommend making sure the case you email from has sCustomerEmail and ixMailbox set.
You can supply any address for the sFrom field, although the UI restricts you to email addresses that FogBugz is actively checking so that when a user replies to your email, it will actually go back into FogBugz. See the Mailboxes edit screen in FogBugz for more info.
Allows you to add hrs in working hours time to dt respecting the working hours. If it was Monday at 3pm and you wanted to know what the date would be for something due in 5 hours, it would give you back the next day, Tuesday at 12 noon.
Any of the optional arguments serve to filter the results. You can reproduce the current behavior of getting release notes for a particular release using the following syntax:. Edits docuumentation existing milestone available with FogBugz 8. Any optional arguments that are not included will clear the corresponding data from the milestone. This command will also remove any associations between a milestone and projects. Manage the list of email addresses which FogBugz auto-completes when you enter a fogbugzz in a case.
View the complete set of EBS milestone work simulations for all docmuentation required to complete this milestone and all of its dependencies.
This is the same data that is displayed in the Docukentation Timeline Report. Like viewUserTimelineReport, but only including the simulation of the final milestone to be completed by each user. This is the same data that is show in the Per-User Ship Date report. View the distribution of overall completion dates for this milestone at this Priority. This is the same data that is shown in the Ship Date report.
View the distribution of projected overall hours remaining to complete this milesone at this Priority. This is the data that is aggregated over time in the Fgobugz Down Chart. List the historical nightly ship date calculations for this milestone at this Priority from the time when the milestone was created until now.
Using the FogBugz Wiki – FogBugz Knowledge Base
This sets the next newly created case to start with this case number. For example, if the current highest case number is 35, and you want the next case number to start atthen you can run this command with the value of Note that you can only use this command to raise documentatlon next value, not lower it.
Please note that this cannot be undone. Using FogBugz On Demand? We’ve recently rolled out a new sidebar as part of taking FogBugz ffogbugz. Please see this article for details on what’s new, what’s changed, and where you can find all your favorite things.
We’ve got some brand new documentation for our API. Click here to check it out. FogBugz has three kinds of filters: To change the current filter pass in the sFilter attribute from the listFilters cmd: Can be a string, a case number, a comma separated list of case numbers without spaces, e.
Note, to search for the number and not the caseenclose your search in quotes. This search acts exactly the same way the search box in FogBugz documentatiin, so you can use that to debug. If q is not present, returns the cases in your current filter.
If the current filter matches a saved or built-in filter, the sFilter is also returned. The parameter should be a comma-separated list of column names e. Available columns are listed below in the case xml output.
Include latestEvent to just get the latest event. For Custom Fields and other plugin fields, see this article. Leave off if you want them all. This functionality is provided for importing cases from another system.
You must import them in order from lowest to highest case number. Existing tags omitted from this list will be removed. If the user does not have Modify on any projects, the return will be Error Code Future edits with hrsCurrEst will change the current estimate, and the original estimate will remain the same.
The ticket for a case, which can be turned into a public ticket URL https: If this is absent, only File1 will upload. If dcumentation fields are omitted, they will not be changed. An example of an html page which submits to the api to create a new case and upload a file would look like this: If this is left off or set to 0, then the API assumes you are looking for all areas that you have permission to read.
If this is left off or set to 0, both private and global snippets for the current user are returned. If ixPerson is set to 1, list the site working schedule.
If omitted, list intervals for the logged on user. If set to 1, list intervals for all users. Note that you must be an administrator to see time interval information for users other than the logged on user.
Do not use with new repositories. If omitted, will mark case as being viewed up to the latest bugevent. Must correspond with the value of sType. When absent, will star for current user. You should not need to look at this field. GetData at line – version 2.
The values for this setting are operating system dependent.
Database may be down or needs to be upgraded. Similarly, all return values starting with those letters will be expressed in UTC.