Skip to main content
Version: QB16

Interact with Discussions

Since QuickBuild 15.0, you can manage build discussions via RESTful APIs. The base URI for changes RESTful APIs is:

/rest/discussions

Show all APIs

MethodURIResponse TypeParams
GET/rest/discussions/helptext/html

List discussions matching the criteria

MethodURIResponse TypeParams
GET/rest/discussionsapplication/json
  • build - QUERY_PARAM
    Build id which you want to list discussions
  • fromBuild - QUERY_PARAM
    Start build id if you want to search in a range of builds
  • toBuild - QUERY_PARAM
    End build id if you want to search in a range of builds
  • configuration - QUERY_PARAM
    Configuration id which you want to list discussions
  • author - QUERY_PARAM
    List discussions created by the author
  • since - QUERY_PARAM
    List discussions created after the date
  • until - QUERY_PARAM
    List discussions created before the date
  • count - QUERY_PARAM
    Number of discussions to return
  • first - QUERY_PARAM
    Index of the first discussion to return

Delete discussions matching the criteria

MethodURIResponse TypeParams
DELETE/rest/discussionsstatus code: 204
  • build - QUERY_PARAM
    Build id which you want to list discussions
  • fromBuild - QUERY_PARAM
    Start build id if you want to search in a range of builds
  • toBuild - QUERY_PARAM
    End build id if you want to search in a range of builds
  • configuration - QUERY_PARAM
    Configuration id which you want to list discussions
  • author - QUERY_PARAM
    List discussions created by the author
  • since - QUERY_PARAM
    List discussions created after the date
  • until - QUERY_PARAM
    List discussions created before the date

Create a new discussion

MethodURIResponse TypeParams
POST/rest/discussions/build/{buildId}application/jsonbuildId in which build to create discussion

Post body example:

{
"comment": "raw-markup-text-comment",
"author": "someone"
}

here:

  • comment: the raw markup text you want to add
  • author: by default (leave empty) the author is the user you are using to access the API. If you want to set to a different author, the user accessing API need have DISCUSSIONS_ADMIN_PERMISSION

Count discussions matching the criteria

MethodURIResponse TypeParams
GET/rest/discussions/countnumber
  • build - QUERY_PARAM
    Build id which you want to count discussions
  • fromBuild - QUERY_PARAM
    Start build id if you want to search in a range of builds
  • toBuild - QUERY_PARAM
    End build id if you want to search in a range of builds
  • configuration - QUERY_PARAM
    Configuration id which you want to count discussions
  • author - QUERY_PARAM
    Count discussions created by the author
  • since - QUERY_PARAM
    Count discussions created after the date
  • until - QUERY_PARAM
    Count discussions created before the date

Get a discussion

MethodURIResponse TypeParams
GET/rest/discussions/{id}application/jsonid - PATH_PARAM Discussion id to list

Delete a discussion

MethodURIResponse TypeParams
DELETE/rest/discussions/{id}status code: 204id - PATH_PARAM Discussion id to list