TEXT   21

bugzilla

Guest on 12th July 2022 03:25:26 PM

  1. Bugzilla Information
  2. ********************
  3.  
  4. These methods are used to get general configuration information about
  5. this Bugzilla instance.
  6.  
  7.  
  8. Version
  9. =======
  10.  
  11. Returns the current version of Bugzilla. Normally in the format of
  12. "X.X" or "X.X.X". For example, "4.4" for the initial release of a new
  13. branch. Or "4.4.6" for a minor release on the same branch.
  14.  
  15. **Request**
  16.  
  17.    GET /rest/version
  18.  
  19. **Response**
  20.  
  21.    {
  22.      "version": "4.5.5+"
  23.    }
  24.  
  25. +---------+--------+-------------------------------------------+
  26. | name    | type   | description                               |
  27. +=========+========+===========================================+
  28. | version | string | The current version of this Bugzilla      |
  29. +---------+--------+-------------------------------------------+
  30.  
  31.  
  32. Extensions
  33. ==========
  34.  
  35. Gets information about the extensions that are currently installed and
  36. enabled in this Bugzilla.
  37.  
  38. **Request**
  39.  
  40.    GET /rest/extensions
  41.  
  42. **Response**
  43.  
  44.    {
  45.      "extensions": {
  46.        "Voting": {
  47.          "version": "4.5.5+"
  48.        },
  49.        "BmpConvert": {
  50.          "version": "1.0"
  51.        }
  52.      }
  53.    }
  54.  
  55. +------------+--------+------------------------------------------------------+
  56. | name       | type   | description                                          |
  57. +============+========+======================================================+
  58. | extensions | object | An object containing the extensions enabled as keys. |
  59. |            |        | Each extension object contains the following keys:   |
  60. |            |        | * "version" (string) The version of the extension.   |
  61. +------------+--------+------------------------------------------------------+
  62.  
  63.  
  64. Timezone
  65. ========
  66.  
  67. Returns the timezone in which Bugzilla expects to receive dates and
  68. times on the API. Currently hard-coded to UTC ("+0000"). This is
  69. unlikely to change.
  70.  
  71. **Request**
  72.  
  73.    GET /rest/timezone
  74.  
  75.    {
  76.      "timezone": "+0000"
  77.    }
  78.  
  79. **Response**
  80.  
  81. +----------+--------+-----------------------------------------------------------------+
  82. | name     | type   | description                                                     |
  83. +==========+========+=================================================================+
  84. | timezone | string | The timezone offset as a string in (+/-)XXXX (RFC 2822) format. |
  85. +----------+--------+-----------------------------------------------------------------+
  86.  
  87.  
  88. Time
  89. ====
  90.  
  91. Gets information about what time the Bugzilla server thinks it is, and
  92. what timezone it's running in.
  93.  
  94. **Request**
  95.  
  96.    GET /rest/time
  97.  
  98. **Response**
  99.  
  100.    {
  101.      "web_time_utc": "2014-09-26T18:01:30Z",
  102.      "db_time": "2014-09-26T18:01:30Z",
  103.      "web_time": "2014-09-26T18:01:30Z",
  104.      "tz_offset": "+0000",
  105.      "tz_short_name": "UTC",
  106.      "tz_name": "UTC"
  107.    }
  108.  
  109. +---------------+--------+------------------------------------------------------------+
  110. | name          | type   | description                                                |
  111. +===============+========+============================================================+
  112. | db_time       | string | The current time in UTC, according to the Bugzilla         |
  113. |               |        | database server.  Note that Bugzilla assumes that the      |
  114. |               |        | database and the webserver are running in the same time    |
  115. |               |        | zone. However, if the web server and the database server   |
  116. |               |        | aren't synchronized or some reason, *this* is the time     |
  117. |               |        | that you should rely on or doing searches and other input  |
  118. |               |        | to the WebService.                                         |
  119. +---------------+--------+------------------------------------------------------------+
  120. | web_time      | string | This is the current time in UTC, according to Bugzilla's   |
  121. |               |        | web server.  This might be different by a second from      |
  122. |               |        | "db_time" since this comes from a different source. If     |
  123. |               |        | it's any more different than a second, then there is       |
  124. |               |        | likely some problem with this Bugzilla instance. In this   |
  125. |               |        | case you should rely  on the "db_time", not the            |
  126. |               |        | "web_time".                                                |
  127. +---------------+--------+------------------------------------------------------------+
  128. | web_time_utc  | string | Identical to "web_time". (Exists only for backwards-       |
  129. |               |        | compatibility with versions of Bugzilla before 3.6.)       |
  130. +---------------+--------+------------------------------------------------------------+
  131. | tz_name       | string | The literal string "UTC". (Exists only for backwards-      |
  132. |               |        | compatibility with versions of Bugzilla before 3.6.)       |
  133. +---------------+--------+------------------------------------------------------------+
  134. | tz_short_name | string | The literal string "UTC". (Exists only for backwards-      |
  135. |               |        | compatibility with versions of Bugzilla before 3.6.)       |
  136. +---------------+--------+------------------------------------------------------------+
  137. | tz_offset     | string | The literal string "+0000". (Exists only for backwards-    |
  138. |               |        | compatibility with versions of Bugzilla before 3.6.)       |
  139. +---------------+--------+------------------------------------------------------------+
  140.  
  141.  
  142. Parameters
  143. ==========
  144.  
  145. Returns parameter values currently used in this Bugzilla.
  146.  
  147. **Request**
  148.  
  149.    GET /rest/parameters
  150.  
  151. **Response**
  152.  
  153. Example response for anonymous user:
  154.  
  155.    {
  156.       "parameters" : {
  157.          "maintainer" : "admin@example.com",
  158.          "requirelogin" : "0"
  159.       }
  160.    }
  161.  
  162. Example response for authenticated user:
  163.  
  164.    {
  165.       "parameters" : {
  166.           "allowemailchange" : "1",
  167.           "attachment_base" : "http://bugzilla.example.com/",
  168.           "commentonchange_resolution" : "0",
  169.           "commentonduplicate" : "0",
  170.           "cookiepath" : "/",
  171.           "createemailregexp" : ".*",
  172.           "defaultopsys" : "",
  173.           "defaultplatform" : "",
  174.           "defaultpriority" : "--",
  175.           "defaultseverity" : "normal",
  176.           "duplicate_or_move_bug_status" : "RESOLVED",
  177.           "emailregexp" : "^[\\w\\.\\+\\-=']+@[\\w\\.\\-]+\\.[\\w\\-]+$",
  178.           "emailsuffix" : "",
  179.           "letsubmitterchoosemilestone" : "1",
  180.           "letsubmitterchoosepriority" : "1",
  181.           "mailfrom" : "bugzilla-daemon@example.com",
  182.           "maintainer" : "admin@example.com",
  183.           "maxattachmentsize" : "1000",
  184.           "maxlocalattachment" : "0",
  185.           "musthavemilestoneonaccept" : "0",
  186.           "noresolveonopenblockers" : "0",
  187.           "password_complexity" : "no_constraints",
  188.           "rememberlogin" : "on",
  189.           "requirelogin" : "0",
  190.           "urlbase" : "http://bugzilla.example.com/",
  191.           "use_see_also" : "1",
  192.           "useclassification" : "1",
  193.           "usemenuforusers" : "0",
  194.           "useqacontact" : "1",
  195.           "usestatuswhiteboard" : "1",
  196.           "usetargetmilestone" : "1",
  197.       }
  198.    }
  199.  
  200. A logged-out user can only access the "maintainer" and "requirelogin"
  201. parameters.
  202.  
  203. A logged-in user can access the following parameters (listed
  204. alphabetically):
  205.  
  206. * allowemailchange
  207.  
  208. * attachment_base
  209.  
  210. * commentonchange_resolution
  211.  
  212. * commentonduplicate
  213.  
  214. * cookiepath
  215.  
  216. * defaultopsys
  217.  
  218. * defaultplatform
  219.  
  220. * defaultpriority
  221.  
  222. * defaultseverity
  223.  
  224. * duplicate_or_move_bug_status
  225.  
  226. * emailregexpdesc
  227.  
  228. * emailsuffix
  229.  
  230. * letsubmitterchoosemilestone
  231.  
  232. * letsubmitterchoosepriority
  233.  
  234. * mailfrom
  235.  
  236. * maintainer
  237.  
  238. * maxattachmentsize
  239.  
  240. * maxlocalattachment
  241.  
  242. * musthavemilestoneonaccept
  243.  
  244. * noresolveonopenblockers
  245.  
  246. * password_complexity
  247.  
  248. * rememberlogin
  249.  
  250. * requirelogin
  251.  
  252. * search_allow_no_criteria
  253.  
  254. * urlbase
  255.  
  256. * use_see_also
  257.  
  258. * useclassification
  259.  
  260. * usemenuforusers
  261.  
  262. * useqacontact
  263.  
  264. * usestatuswhiteboard
  265.  
  266. * usetargetmilestone
  267.  
  268. A user in the tweakparams group can access all existing parameters.
  269. New parameters can appear or obsolete parameters can disappear
  270. depending on the version of Bugzilla and on extensions being
  271. installed. The list of parameters returned by this method is not
  272. stable and will never be stable.
  273.  
  274.  
  275. Last Audit Time
  276. ===============
  277.  
  278. Gets the most recent timestamp among all of the events recorded in the
  279. audit_log table.
  280.  
  281. **Request**
  282.  
  283. To get most recent audit timestamp for all classes:
  284.  
  285.    GET /rest/last_audit_time
  286.  
  287. To get the the most recent audit timestamp for the "Bugzilla::Product"
  288. class:
  289.  
  290.    GET /rest/last_audit_time?class=Bugzilla::Product
  291.  
  292. +-------+-------+---------------------------------------------------------------------+
  293. | name  | type  | description                                                         |
  294. +=======+=======+=====================================================================+
  295. | class | array | The class names are defined as "Bugzilla::<class_name>"" such as    |
  296. |       |       | Bugzilla:Product`` for products.                                    |
  297. +-------+-------+---------------------------------------------------------------------+
  298.  
  299. **Response**
  300.  
  301.    {
  302.      "last_audit_time": "2014-09-23T18:03:38Z"
  303.    }
  304.  
  305. +-----------------+--------+------------------------------------------------------+
  306. | name            | type   | description                                          |
  307. +=================+========+======================================================+
  308. | last_audit_time | string | The maximum of the at_time from the audit_log.       |
  309. +-----------------+--------+------------------------------------------------------+
  310.  
  311. ======================================================================
  312.  
  313. This documentation undoubtedly has bugs; if you find some, please file
  314. them here.

Raw Paste


Login or Register to edit or fork this paste. It's free.