Example code from FogBugzPy documentation:. The CustomFields plugin allows you to add yor own elements to cases in FogBugz. Also, any punctuation is transformed, so you will need to look up what your custom field is with fborm. Once you know that, you can simplify your code by setting a namemap for the returned data. This means that if you have multiple servers with the same CustomFields, they will have different names in the API.
|Published (Last):||4 July 2019|
|PDF File Size:||12.99 Mb|
|ePub File Size:||20.97 Mb|
|Price:||Free* [*Free Regsitration Required]|
Welcome to the Manuscript API! You can use our API to read and write data in your Manuscript instance. The Manuscript API makes it possible to do programmatically almost anything you could do in the interface.
The API can be used alone or in conjunction with Manuscript webhooks and third party services such as Slack, Salesforce, or TestRail among many others to build powerful integrations to improve your workflow and make the connection between Manuscript and your other systems seamless. Find links to our full documentation in the sidebar to the left.
You can view code examples in the code viewer on the right. Have questions? Our support engineers are here to help. The minversion field is used to warn you if the current version of the API is not backwards compatible. Hard code the API version in your script. Users with two factor authentication enabled cannot generate an API token through the API - they must generate a token through the Manuscript user interface.
You can generate an API token by providing an email address or full name just like the Manuscript sign-in page and password to the logon endpoint. We encourage you to reuse your tokens rather than issue repeated logon requests see below. There is more than one Manuscript user with that email address. Manuscript will provide you with a list of full names; you must execute the request again using the appropriate full name.
Logging off is not necessary and we encourage you to reuse tokens. The BugzScout API requires more information about the incoming case workflow, and is a good fit for automated crash reporting in programs. The API requires a valid Normal or Administrator login, and is a good fit for automating internal workflows. Both have very similar features. Read more about that under editing cases. This is identical to the API command to create a new case , but requries the sScoutDescription parameter.
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 all at the same time using the cols parameter.
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 at , then you can run this command with the value of Note that you can only use this command to raise the next value, not lower it. This cannot be undone. In addition to the parameters listed below, this command accepts ixPersonEditedBy and dt parameters from Site Admininistrators to enable accurate imports with the API.
Note that setting ixPersonEditedBy when using the command new sets who opened the case. For Custom Fields and other plugin fields, see this article. File uploads require special handling. Returns a list of all events in the case. The sample output here shows only a single case for space considerations. For the sake of space, the sample includes only one category. We are taking your suggestion into consideration.
We will get to your request soon. From 3. The evidence based scheduling API endpoints have been deprecated. If you have questions about EBS, please contact us. The data for the specified milestone. If the returned data specifies an ixProject of -1, the milestone is a global milestone. If dtRelease is left blank, the release date for the milestone will be cleared.
Create a dependency between two milestones. Remove a dependency between two milestones. Details about the areas in Manuscript. If ixPersonOwner is 0 for a particular area, the primary contact for that area is whoever is the primary contact for the project. Details about the selected area. If ixPersonOwner is -1, the primary contact for that area is whoever is the primary contact for the project. Associate a new Source Control commit with a Manuscript case.
Details of Source Control checkins associated with this case. Start work on a specific case as the logged in user. It is only possible to start work on a case that already has an estimate. This endpoint allows you to edit a wiki article. Please note that for sHeadline and sBody, not specifying their values will erase the current contents of those fields. Logging on Through the API You can generate an API token by providing an email address or full name just like the Manuscript sign-in page and password to the logon endpoint.
Please choose the specific user you would like to log in as. Query Parameters Parameter Default Description sScoutDescription required Manuscript will continue appending to this case unless fScoutStopReporting is true for that case in which case it will do nothing. Requires either sText or sHtml, but not both. List Cases Fetches a list of Manuscript cases. Query Parameters Parameter Default Description sFilter optional Set this to the ixFilter of an existing filter to show only cases returned by that filter cols optional The columns you want returned max optional The maximum number of cases to be returned.
Defaults to 50, if left off or set to 0. The maximum returned results is ,; any higher than this will return error code Search Cases 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 all at the same time using the cols parameter.
Can be a string, a case number, a comma separated list of case numbers without spaces e. This search acts exactly the same way the search box in Manuscript operates, so you can use that to debug. 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. The highest this can be set to is , Anything higher will produce error code Successful response A list of Manuscript cases matching your search query. To display the actual number ofoccurrences, add 1 to this number.
If you want the complete event records with all columns, use events instead. See listKanbanColumns. Mark a Case as Viewed Sets a case as viewed. Create a New Case Creates a new case. 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 Insufficient Permissions.
The first instance of time logged against the case set the most recent current estimate as the original estimate. Future edits with hrsCurrEst will change the current estimate, and the original estimate will remain the same. Will be rejected if the selected Kanban column does not belong to the same project as the case. File1, File2, File3, etc optional Upload files to the case. There is no limit to the number of files that can be appended; this is constrained only by the max upload limit on the web server.
If this is absent, only File1 will upload. Edit an Existing Case Edits the specified case. Example: ,, will set cases , , and as children. Reassign an Existing Case Assigns the case. Parameter Default Description ixBug required The case you wish to act on. Resolve an Active Case Sets the case status to resolved. Reactivate a Resolved Case Sets the status of a resolved case to active. Close a Case Closes a resolved case.
Reopen a Closed Case Reopens a closed case. For case details, this should be a case number, or a comma separated list of case numbers without spaces e. You should not need to look at this field.
Instead use fEmail to determine if the event is an email and sFormat to determine if an edit is html-formatted "sFormat" : html, 'html' if the event was created in HTML mode via Rich Case Events "fExternal" : false , True if this case was created via an incoming email, discussion topic, or BugzScout "sChanges" : "Project changed from 'Inbox' to 'Cave'. View a Single Category Returns a single Manuscript category.
Reply to an Email Send a reply to an email. Forward an Email Forward an email that has been received. Email Correspondents Add a Correspondent Add an email address to the correspondents list.
FogBugz XML API Documentation: Introduction
Welcome to the Manuscript API! You can use our API to read and write data in your Manuscript instance. The Manuscript API makes it possible to do programmatically almost anything you could do in the interface. The API can be used alone or in conjunction with Manuscript webhooks and third party services such as Slack, Salesforce, or TestRail among many others to build powerful integrations to improve your workflow and make the connection between Manuscript and your other systems seamless. Find links to our full documentation in the sidebar to the left. You can view code examples in the code viewer on the right.
FogBugz XML API Version 8
FogBugz is an integrated web-based project management system featuring bug and issue tracking , discussion forums , wikis , customer relationship management , and evidence-based scheduling originally developed by Fog Creek Software. FogBugz was re-branded as Manuscript at the end of On August 3, Manuscript was acquired by DevFactory. From Wikipedia, the free encyclopedia. This article has multiple issues.