Bugzilla:BzAPI:Methods: Difference between revisions

Bugzilla:BzAPI:Methods (view source)

Revision as of 03:08, 17 December 2009

96 bytes added , 17 December 2009

no edit summary

Gerv

Account confirmers, Anti-spam team, Confirmed users, Bureaucrats and Sysops emeriti

4,925

edits

@@ Line 8: / Line 8: @@
 === Search for bugs (/bug GET) ===
-'''Input'''
+'''Arguments'''
 [[Bugzilla:REST_API:Search|Search parameters]], exactly as powerful as query.cgi but using the field names from the Bug object rather than those from the web interface. (At the moment, it does also support the field names from the web interface, to make it easy to port URLs and other code across. But if supporting this becomes difficult, it might go away.)
-'''Output'''
+'''Response'''
   { "bugs": [ <array of [[Bugzilla:REST_API:Objects#Bug|Bug]]> ] }
@@ Line 25: / Line 25: @@
 === Count bugs (/count GET) ===
-'''Input'''
+'''Arguments'''
 [[Bugzilla:REST_API:Search|Search parameters]], as above, plus zero or more of '''x_axis_field''', '''y_axis_field''' and '''z_axis_field'''.
-'''Output'''
+'''Response'''
 Counts of bugs, as a scalar, 1D, 2D or 3D array depending on how many axis_field parameters you specified.
@@ Line 49: / Line 49: @@
 === Create new bug (/bug POST) ===
-'''Input'''
+'''Arguments'''
 [[Bugzilla:REST_API:Objects#Bug|Bug]], or part thereof, as POST body. The following fields are always compulsory: '''product''', '''component''', '''summary''' and '''version'''. The following fields may be compulsory depending on the configuration of your Bugzilla: '''description''', '''op_sys''', '''platform''', '''priority''' and '''severity'''.
-'''Output'''
+'''Response'''
 Created status code, Location header pointing to new bug object.
@@ Line 67: / Line 67: @@
 === Retrieve bug (/bug/<id> GET) ===
-'''Input'''
+'''Arguments'''
 * Bug ID on the URL
@@ Line 75: / Line 75: @@
 * Multi-valued custom fields are not, in general, returned as arrays if there is 0 or 1 value. This is because I can't tell which custom fields are supposed to be multi-valued. As a hack, if your custom field name begins "cf_multi", it will get unconditionally array-ified. This limitation can only be lifted when the API is part of Bugzilla itself.
-'''Output'''
+'''Response'''
 [[Bugzilla:REST_API:Objects#Bug|Bug]].
@@ Line 88: / Line 88: @@
 === Update bug (/bug/<id> PUT) ===
-'''Input'''
+'''Arguments'''
 [[Bugzilla:REST_API:Objects#Bug|Bug]], or part thereof, as PUT body.
-'''Output'''
+'''Response'''
   { "ok": 1 }
@@ Line 115: / Line 115: @@
 === List comments for bug (/bug/<id>/comment GET) ===
-'''Input'''
+'''Arguments'''
 * Bug ID on the URL
 * "new_since" DateTime parameter (YYYYMMDDTHHMMSS format only) returns only ones since date given. (3.4 or above only)
-'''Output'''
+'''Response'''
   { "comments": [ array of [[Bugzilla:REST_API:Objects#Comment|Comment]] ] }
@@ Line 137: / Line 137: @@
 === Add new comment to bug (/bug/<id>/comment POST) ===
-'''Input'''
+'''Arguments'''
 [[Bugzilla:REST_API:Objects#Comment|Comment]] as POST body.
-'''Output'''
+'''Response'''
 Created status code, Location header pointing to bug/<id>/comment (as individual comments don't have their own location).
@@ Line 156: / Line 156: @@
 === List history for bug (/bug/<id>/history GET) ===
-'''Input'''
+'''Arguments'''
 * Bug ID on the URL.
-'''Output'''
+'''Response'''
   { "history": [ array of [[Bugzilla:REST_API:Objects#ChangeSet|ChangeSet]] ] }
@@ Line 175: / Line 175: @@
 === List flags for bug (/bug/<id>/flag GET) ===
-'''Input'''
+'''Arguments'''
 * Bug ID on the URL.
-'''Output'''
+'''Response'''
   { "flags": [ array of [[Bugzilla:REST_API:Objects#Flag|Flag]] ] }
@@ Line 195: / Line 195: @@
 === List attachments for bug (/bug/<id>/attachment GET) ===
-'''Input'''
+'''Arguments'''
 * Bug ID on the URL.
 * attachmentdata=1 does the obvious thing.
-'''Output'''
+'''Response'''
   { "attachments": [ array of [[Bugzilla:REST_API:Objects#Attachment|Attachment]] ] }
@@ Line 215: / Line 215: @@
 === Create new attachment (/bug/<id>/attachment POST) ===
-'''Input'''
+'''Arguments'''
 [[Bugzilla:REST_API:Objects#Attachment|Attachment]] as POST body.
-'''Output'''
+'''Response'''
 Created status code, Location header pointing to new object.
@@ Line 234: / Line 234: @@
 === Retrieve attachment (/attachment/<id> GET) ===
-'''Input'''
+'''Arguments'''
 * Attachment ID on the URL.
 * attachmentdata=1 does the obvious thing.
-'''Output'''
+'''Response'''
 [[Bugzilla:REST_API:Objects#Attachment|Attachment]].
@@ Line 251: / Line 251: @@
 === Update attachment metadata (/attachment/<id> PUT) ===
-'''Input'''
+'''Arguments'''
 [[Bugzilla:REST_API:Objects#Attachment|Attachment]] as PUT body.
-'''Output'''
+'''Response'''
   { "ok": 1 }
@@ Line 271: / Line 271: @@
 === Search for users (/user GET) ===
-'''Input'''
+'''Arguments'''
 * "match" parameter with string to match against either name or real_name.
-'''Output'''
+'''Response'''
   { users: [ array of [[Bugzilla:REST_API:Objects#User|User]] ] }
@@ Line 289: / Line 289: @@
 === Retrieve user (/user/<id> GET) ===
-'''Input'''
+'''Arguments'''
 User ID on the URL. Can be numeric ID or email address.
-'''Output'''
+'''Response'''
 [[Bugzilla:REST_API:Objects#User|User]].
@@ Line 308: / Line 308: @@
 === Configuration (/configuration GET) ===
-'''Input'''
+'''Arguments'''
 * None
-'''Output'''
+'''Response'''
   [[Bugzilla:REST_API:Objects:Configuration|Configuration]]