Information

View a Case

This API is a limited view of a FogBugz case, intended for use by Bot Users.

Query Parameters

• ixBug (required)
• token (required)

HTTP Request

POST https://apisandbox.fogbugz.com/api/viewCase

{
"ixBug": "5527",
"token": "3glpahm7p456aaq3k5458j8p2mp7o2",
}

Success Response

{
 "data": {
 "case": {
 "ixBug": 5527,
 "operations": [
 "edit",
 "assign",
 "resolve",
 "email"
 ]
 }
 },
 "errors": [],
 "warnings": [],
 "meta": {
 "jsdbInvalidator": "7CJL8aTK8kmpQdpNf4dEng2",
 "clientVersionAllowed": {
 "min": 5,
 "max": 5
 }
 },
 "errorCode": null,
 "maxCacheAge": null
}

Back to top

List Cases

This API fetches a list of FogBugz cases.

Query Parameters

• sFilter
• cols
• max
• token (required)

HTTP Request

POST https://apisandbox.fogbugz.com/api/listCases

{
"sFilter": "42",
"token": "3glpahm7bca6aaq3k5911j8p2mp7o2",
"cols": ["ixBug", "sTitle", "sPersonAssignedTo"],
"max": 2
}

Success Response

{
 "data": {
 "description": "All open cases",
 "count": 2,
 "totalHits": 244,
 "cases": [
 {
 "operations": [
 "edit",
 "assign",
 "resolve",
 "email"
 ],
 "ixBug": 1,
 "sTitle": "\"Welcome to FogBugz\" Sample Case",
 "sPersonAssignedTo": "Andrew"
 },
 {
 "operations": [
 "edit",
 "assign",
 "resolve",
 "email"
 ],
 "ixBug": 2,
 "sTitle": "Intro Case for Andrew",
 "sPersonAssignedTo": "Andrew"
 }
 ]
 },
 "errors": [],
 "warnings": [],
 "meta": {
 "jsdbInvalidator": "0VWMee3CTEeeiJeOGm5kDw2",
 "clientVersionAllowed": {
 "min": 5,
 "max": 5
 }
 },
 "errorCode": null,
 "maxCacheAge": null
}

Back to top

Search Cases

This 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.

Query Parameters

• q
• cols
• max
• token (required)

HTTP Request

POST https://apisandbox.fogbugz.com/api/search

{
"token": "3glpahm7bca6aaq3k5911j8p2mp7o2",
"q": "project:inbox assignedTo:Kevin",
"cols": ["ixProject", "ixPersonAssignedTo", "sTitle"],
"max": 2
}

Success Response

{
 "data": {
 "count": 2,
 "totalHits": 2,
 "cases": [
 {
 "ixBug": 5523,
 "operations": [
 "edit",
 "assign",
 "resolve",
 "email"
 ],
 "ixProject": 2,
 "ixPersonAssignedTo": 13,
 "sTitle": "There are too many bugs in these replicants"
 },
 {
 "ixBug": 5522,
 "operations": [
 "edit",
 "assign",
 "resolve",
 "email"
 ],
 "ixProject": 2,
 "ixPersonAssignedTo": 13,
 "sTitle": "Where have all the cowboys gone"
 }
 ]
 },
 "errors": [],
 "warnings": [],
 "meta": {
 "jsdbInvalidator": "jGJtarJnF0q2oJ7Y8ylT2Q2",
 "clientVersionAllowed": {
 "min": 5,
 "max": 5
 }
 },
 "errorCode": null,
 "maxCacheAge": null
}

Back to top