Confluence Questions REST ResourcesPUBLIC SINCE 2.3
by Atlassian for Confluence Server 5.3+
TopicResource
The following resources are applicable:
- /topic
- /topic/{topicId}
- /topic/{topicId}/logo
- /topic/{topicId}/stats
- /topic/{topicId}/watch
- /topic/{topicId}/watch/{userKey}
- /topic/featured
- /topic/search
- /topic/suggest
- /topic/tempLogo
/topic
Mount Point: /rest/questions/1.0/topic
POST
Add a new topic. Please note that only administrators can make it featured
Request Body
| element: | editTopicJson |
| media types: | application/json |
a JSON representation of com.atlassian.confluence.plugins.questions.rest.json.EditTopicJson
Response Body
| element: | topicDTO |
| media types: | application/json |
a JSON representation of com.atlassian.confluence.plugins.questions.api.dto.TopicDTO
GET
Get topics' info
Parameters
| name | description | type | default |
|---|---|---|---|
| limit | (no documentation provided) | query | 10 |
| start | (no documentation provided) | query | 0 |
| loadQuestionsCount | (no documentation provided) | query | true |
| loadLatestQuestionTitle | (no documentation provided) | query | false |
| isFeatured | (no documentation provided) | query | false |
| loadAvatar | (no documentation provided) | query | true |
Response Body
| element: | topicInfoDTO |
| media types: | application/json |
(no documentation provided)
/topic/{topicId}
Mount Point: /rest/questions/1.0/topic/{topicId}
The following operations are supported on this resource:
DELETE
Delete a topic
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | ID of the topic needs to be deleted | path |
Response Body
| element: | (custom) |
| media types: | application/json |
200 OK on success or 400 BAD_REQUEST on failure
PUT
Update a topic. Please note that only administrators can make a topic featured or vice versa.
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | ID of the topic needs to be updated | path |
Request Body
| element: | editTopicJson |
| media types: | application/json |
a JSON representation of com.atlassian.confluence.plugins.questions.rest.json.EditTopicJson
Response Body
| element: | topicDTO |
| media types: | application/json |
a JSON representation of com.atlassian.confluence.plugins.questions.api.dto.TopicDTO
GET
Get a topic
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | (no documentation provided) | path |
Response Body
| element: | topicDTO |
| media types: | application/json |
(no documentation provided)
/topic/{topicId}/logo
Mount Point: /rest/questions/1.0/topic/{topicId}/logo
POST
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | (no documentation provided) | path | |
| offsetX | (no documentation provided) | query | -1 |
| offsetY | (no documentation provided) | query | -1 |
| width | (no documentation provided) | query | -1 |
| scaledWidth | (no documentation provided) | query |
Request Body
| element: | filePart |
| media types: | multipart/form-data |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | text/html |
(no documentation provided)
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | ID of the topic | path |
Response Body
| element: | (custom) |
| media types: | images/png |
the topic's logo path
/topic/{topicId}/stats
Mount Point: /rest/questions/1.0/topic/{topicId}/stats
GET
Get a topic's statistics
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | (no documentation provided) | path |
Response Body
| element: | topicStatisticsDTO |
| media types: | application/json |
(no documentation provided)
/topic/{topicId}/watch
Mount Point: /rest/questions/1.0/topic/{topicId}/watch
The following operations are supported on this resource:
GET
Get watchers of a topic
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | (no documentation provided) | path |
Response Body
| element: | userDTO |
| media types: | application/json |
(no documentation provided)
POST
Add a watcher of a topic by the watcher's username
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | (no documentation provided) | path | |
| username | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/json |
200 OK on success or 204 NO CONTENT if the topic is not found
DELETE
Remove a watcher of a topic
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | (no documentation provided) | path | |
| userName | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | application/json |
200 OK on success or 204 NO CONTENT if the topic is not found
/topic/{topicId}/watch/{userKey}
Mount Point: /rest/questions/1.0/topic/{topicId}/watch/{userKey}
The following operations are supported on this resource:
POST
Add a watcher of a topic by the watcher's user key
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | (no documentation provided) | path | |
| userKey | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/json |
200 OK on success or 204 NO CONTENT if the topic is not found
DELETE
Remove a watcher of a topic
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | (no documentation provided) | path | |
| userKey | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/json |
200 OK on success or 204 NO CONTENT if the topic is not found
GET
Check if a user is watching a topic
Parameters
| name | description | type | default |
|---|---|---|---|
| topicId | the topic ID to check against | path | |
| userKey | the user's unique key | path |
Response Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
/topic/featured
Mount Point: /rest/questions/1.0/topic/featured
GET
Get featured topics
Response Body
| element: | topicDTO |
| media types: | application/json |
(no documentation provided)
/topic/search
Mount Point: /rest/questions/1.0/topic/search
GET
Search a topic by name
Parameters
| name | description | type | default |
|---|---|---|---|
| name | (no documentation provided) | query |
Response Body
| element: | topicDTO |
| media types: | application/json |
(no documentation provided)
/topic/suggest
Mount Point: /rest/questions/1.0/topic/suggest
GET
Suggest topics based on the entered query string
Parameters
| name | description | type | default |
|---|---|---|---|
| query | the query string used in topic matching algorithm | query | |
| maxSuggestions | the number of suggestions returned | query | 10 |
| page | (no documentation provided) | query | 0 |
| loadAvatar | . Set false if you don't want load topic's avatar | query | true |
Response Body
| element: | (custom) |
| media types: | application/json |
the suggested topics
/topic/tempLogo
Mount Point: /rest/questions/1.0/topic/tempLogo
POST
Uploads a logo image for temporary use for IE.
Request Body
| element: | filePart |
| media types: | multipart/form-data |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | text/html |
(no documentation provided)