This user guide only applies if your account and project is on our new platform, i.e. if your project's URL begins with https://<your-account>.xp-dev.com rather than https://xp-dev.com. If your account is on our old platform, you should be using this user guide instead.
Each Forum Topic Object has the following attributes:
Attribute | Description |
---|---|
id | Unique Forum Topic ID |
title | Forum Topic title |
description | Forum Topic description in Textile |
htmlDescription | Forum Topic description in HTML |
forum | Forum Object that the Forum Topic belongs to |
sticky | Whether this is Forum Topic is sticky or not |
GET
request to
https://<your-account>.xp-dev.com/api/v1/forumtopics/forum/<forum-id>
:
curl https://<your-account>.xp-dev.com/api/v1/forumtopics/forum/3
Responses will be a list of Forum Topics Objects:
[
{
"id":2,
"description":"I need some Subversion help",
"forum": {
"id": 2
},
"title":"Subversion Help",
"sticky":false,
"htmlDescription":"<p>I need some Subversion help</p>"
},
...
]
GET
request to
https://<your-account>.xp-dev.com/api/v1/forumtopics/project/<project-id>
:
curl https://<your-account>.xp-dev.com/api/v1/forumtopics/project/3
Responses will be a list of Forum Topics Objects.
POST
request to https://<your-account>.xp-dev.com/api/v1/forumtopics
with the
following attributes:
Mandatory:
Example request:
curl -X POST -H 'Content-Type: application/json' -d '{"description":"I need Subversion help","forum":{"id":4},"title":"Subversion Help","sticky":false}' https://<your-account>.xp-dev.com/api/v1/forumtopics
Responses will be in the form of a single Forum Topic Object
GET
request to https://<your-account>.xp-dev.com/api/v1/forumtopics/<forumtopic-id>
. For example:
curl https://<your-account>.xp-dev.com/api/v1/forumtopics/6
Responses will be in the form of a single Forum Topic Object
PUT
request to https://<your-account>.xp-dev.com/api/v1/forumtopics/<forumtopic-id>
with the following attributes:
Mandatory:
Example request:
curl -X PUT -H 'Content-Type: application/json' -d '{"description":"I need Subversion help","title":"Subversion Help","sticky":true}' https://<your-account>.xp-dev.com/api/v1/forumtopics/6
Responses will be in the form of a single Forum Topic Object
DELETE
request to https://<your-account>.xp-dev.com/api/v1/forumtopics/<forumtopic-id>
:
curl -X DELETE https://<your-account>.xp-dev.com/api/v1/forumtopics/6
Feel free to contact us if you need any assistance.